Further Javadoc doclint fixes

References #1516 [build] doclint error during build
This commit is contained in:
Andreas Dangel
2017-01-07 17:05:03 +01:00
parent 79847dd3e9
commit e1d12dd4f8
8 changed files with 52 additions and 55 deletions

View File

@ -15,7 +15,7 @@ import org.junit.Test;
/**
*
* @author Romain Pelisse <belaran@gmail.com>
* @author Romain Pelisse &lt;belaran@gmail.com&gt;
*
*/
public class CPDTaskTest {

View File

@ -21,7 +21,7 @@ import org.w3c.dom.NodeList;
/**
* @author Philippe T'Seyen
* @author Romain Pelisse <belaran@gmail.com>
* @author Romain Pelisse &lt;belaran@gmail.com&gt;
*
*/
public class XMLRendererTest {

View File

@ -55,31 +55,31 @@ import junit.framework.AssertionFailedError;
/**
* This class tests the Statistical Rules in PMD.
* <p/>
* The idea is, that we fill up 999 datapoints into the Stat Rule, and then
* throw random parameters at it.
* <p/>
* The three parameters which are checked are: sigma - # Sigmas over the mean.
*
* <p>The idea is, that we fill up 999 datapoints into the Stat Rule, and then
* throw random parameters at it.</p>
*
* <p>The three parameters which are checked are: sigma - # Sigmas over the mean.
* topscore - Only the top 5 or so items. minimum - Only things of score 10 or
* better
* <p/>
* When more than one parameter is lumped together, then we expect the one which
* would return the fewest to determine what gets sent back.
* <p/>
* So, we throw each collection of parameters, where each one is a different
* better</p>
*
* <p>When more than one parameter is lumped together, then we expect the one which
* would return the fewest to determine what gets sent back.</p>
*
* <p>So, we throw each collection of parameters, where each one is a different
* order into the system. We check the results off of what the smallest value
* should be.
* <p/>
* If you are going to work with StatisticalRule any, please bump the
* should be.</p>
*
* <p>If you are going to work with StatisticalRule any, please bump the
* "NUM_TESTS" number up to something like 128. That way you are more likely to
* identify problems. It is set low now to make building and running tests
* easier (when we aren't touching the file.)
* <p/>
* Note also, that when verifying the Sigma, I wasn't quite able to determine
* easier (when we aren't touching the file.)</p>
*
* <p>Note also, that when verifying the Sigma, I wasn't quite able to determine
* how many results it would return (it would vary from -2 to 2 of what I
* expected.) That is what the delta parameter on the verify method takes. If
* you can figure it out exactly, (without stealing code from the StatRule) then
* feel free to change it and tighten the deltas.
* feel free to change it and tighten the deltas.</p>
*/
public class StatisticalRuleTest {
@ -226,9 +226,9 @@ public class StatisticalRuleTest {
/**
* This returns the expected number of reports.
* <p/>
* If the Minimum comes in at 521.569 then we expect 522, 523, ... 999 will
* pass.
*
* <p>If the Minimum comes in at 521.569 then we expect 522, 523, ... 999 will
* pass.</p>
*/
public int expectedMinimum(double minimum) {
Double d = Double.valueOf(minimum);

View File

@ -15,7 +15,7 @@ import org.junit.Test;
import net.sourceforge.pmd.util.FileUtil;
/**
* @author Romain Pelisse <belaran@gmail.com>
* @author Romain Pelisse &lt;belaran@gmail.com&gt;
*
*/
public class CLITest extends BaseCLITest {

View File

@ -21,10 +21,7 @@ public class ParserCornersTest extends ParserTst {
/**
* #1107 PMD 5.0.4 couldn't parse call of parent outer java class method
* from inner class
*
* @throws Exception
* any error
* from inner class.
*/
@Test
public void testInnerOuterClass() {

View File

@ -13,7 +13,7 @@ import org.junit.Test;
import net.sourceforge.pmd.util.FileUtil;
/**
* @author Romain Pelisse <belaran@gmail.com>
* @author Romain Pelisse &lt;belaran@gmail.com&gt;
*
*/
public class CLITest extends BaseCLITest {

View File

@ -143,7 +143,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* Test parsing of HTML <script> element.
* Test parsing of HTML &lt;script&gt; element.
*/
@Test
public void testHtmlScript() {
@ -154,7 +154,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* Test parsing of HTML <script src="x"/> element. It might not be valid
* Test parsing of HTML &lt;script src="x"/&gt; element. It might not be valid
* html but it is likely to appear in .JSP files.
*/
@Test
@ -167,7 +167,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* Test parsing of HTML <script> element.
* Test parsing of HTML &lt;script&gt; element.
*/
@Test
public void testHtmlScriptWithAttribute() {
@ -193,7 +193,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* Test parsing of HTML <script> element.
* Test parsing of HTML &lt;script&gt; element.
*/
@Test
public void testInlineCss() {
@ -298,7 +298,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* A dangling unopened ( just </closed> ) tag should not influence the
* A dangling unopened ( just &lt;/closed&gt; ) tag should not influence the
* parsing.
*/
@Test
@ -326,7 +326,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* Test parsing of HTML <script> element.
* Test parsing of HTML &lt;script&gt; element.
*/
@Test
public void textAfterOpenAndClosedTag() {
@ -397,7 +397,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* tests whether parse correctly detects presence of JSP expression <%= %>
* tests whether parse correctly detects presence of JSP expression &lt;%= %&gt;
* within an non-quoted attribute value
*/
@Test
@ -458,7 +458,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
/**
* tests whether parse does not fail in the presence of unclosed JSP
* expression <%= within an non-quoted attribute value
* expression &lt;%= within an non-quoted attribute value
*/
@Test
public void noQuoteAttrWithMalformedJspExpression() {
@ -469,7 +469,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* test a no quote attribute value which contains a scriptlet <% %> within
* test a no quote attribute value which contains a scriptlet &lt;% %&gt; within
* its value
*/
@Test
@ -484,7 +484,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
/**
* test a no quote attribute value can contain a tag (e.g.
* attr=<bean:write property="value" />)
* attr=&lt;bean:write property="value" /&gt;)
*
*/
@Test
@ -499,7 +499,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
/**
* test a quote attribute value can contain a tag (e.g.
* attr="<bean:write property="value" />" ) Not sure if it's legal JSP code
* attr="&lt;bean:write property="value" /&gt;" ) Not sure if it's legal JSP code
* but most JSP engine accept and properly treat this value at runtime
*/
@Test
@ -586,7 +586,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* <html> <a1> <a2/> <b/> </a1> </html>
* &lt;html&gt; &lt;a1&gt; &lt;a2/&gt; &lt;b/&gt; &lt;/a1&gt; &lt;/html&gt;
*/
@Test
public void nestedEmptyTags() {
@ -617,7 +617,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* <html> <a1> <a2> <a3> </a2> </a1> <b/> <a4/> </html>
* &lt;html&gt; &lt;a1&gt; &lt;a2&gt; &lt;a3&gt; &lt;/a2&gt; &lt;/a1&gt; &lt;b/&gt; &lt;a4/&gt; &lt;/html&gt;
*/
@Test
public void nestedMultipleTags() {
@ -658,8 +658,8 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* will test <x> <a> <b> <b> </x> </a> </x> . Here x is the first tag to be
* closed thus rendering the next close of a (</a>) to be disregarded.
* will test &lt;x&gt; &lt;a&gt; &lt;b&gt; &lt;b&gt; &lt;/x&gt; &lt;/a&gt; &lt;/x&gt; . Here x is the first tag to be
* closed thus rendering the next close of a (&lt;/a&gt;) to be disregarded.
*/
@Test
public void unclosedParentTagClosedBeforeChild() {
@ -689,10 +689,10 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* <x> <a> <b> <b> </z> </a> </x> An unmatched closing of 'z' appears
* &lt;x&gt; &lt;a&gt; &lt;b&gt; &lt;b&gt; &lt;/z&gt; &lt;/a&gt; &lt;/x&gt; An unmatched closing of 'z' appears
* randomly in the document. This should be disregarded and structure of
* children and parents should not be influenced. in other words </a> should
* close the first <a> tag , </x> should close the first <x>, etc.
* children and parents should not be influenced. in other words &lt;/a&gt; should
* close the first &lt;a&gt; tag , &lt;/x&gt; should close the first &lt;x&gt;, etc.
*/
@Test
public void unmatchedTagDoesNotInfluenceStructure() {
@ -722,9 +722,9 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* <a> <x> <a> <b> <b> </z> </a> </x> An unmatched closing of 'z' appears
* &lt;a&gt; &lt;x&gt; &lt;a&gt; &lt;b&gt; &lt;b&gt; &lt;/z&gt; &lt;/a&gt; &lt;/x&gt; An unmatched closing of 'z' appears
* randomly in the document. This should be disregarded and structure of
* children and parents should not be influenced. Also un unclosed <a> tag
* children and parents should not be influenced. Also un unclosed &lt;a&gt; tag
* appears at the start of the document
*/
@Test
@ -760,7 +760,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst {
}
/**
* {@link #TEST_UNCLOSED_END_OF_DOC} <tag:x> <tag:y> Tests whether parser
* {@link #TEST_UNCLOSED_END_OF_DOC} &lt;tag:x&gt; &lt;tag:y&gt; Tests whether parser
* breaks on no closed tags at all
*/
// This is yet to be improved. If a closing tag does not

View File

@ -22,7 +22,7 @@ public class OpenTagRegisterTest {
}
/**
* <a> <b> </a>
* &lt;a&gt; &lt;b&gt; &lt;/a&gt;
*/
@Test
public void testSimpleNesting() {
@ -38,7 +38,7 @@ public class OpenTagRegisterTest {
}
/**
* <a> <b> <b> </a>
* &lt;a&gt; &lt;b&gt; &lt;b&gt; &lt;/a&gt;
*/
@Test
public void doubleNesting() {
@ -57,7 +57,7 @@ public class OpenTagRegisterTest {
}
/**
* <x> <a> <b> <b> </x> </a> </x>
* &lt;x&gt; &lt;a&gt; &lt;b&gt; &lt;b&gt; &lt;/x&gt; &lt;/a&gt; &lt;/x&gt;
*/
@Test
public void unopenedTags() {
@ -82,7 +82,7 @@ public class OpenTagRegisterTest {
}
/**
* <x> <a> <b> <b> </z> </a> </x>
* &lt;x&gt; &lt;a&gt; &lt;b&gt; &lt;b&gt; &lt;/z&gt; &lt;/a&gt; &lt;/x&gt;
*
*/
@Test
@ -109,7 +109,7 @@ public class OpenTagRegisterTest {
}
/**
* <a> <x> <a> <b> <b> </z> </a> </x>
* &lt;a&gt; &lt;x&gt; &lt;a&gt; &lt;b&gt; &lt;b&gt; &lt;/z&gt; &lt;/a&gt; &lt;/x&gt;
*/
@Test
public void openedIsolatedTag() {