From e1d12dd4f85fa3d102051d3d61d51c12a2199530 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Sat, 7 Jan 2017 17:05:03 +0100 Subject: [PATCH] Further Javadoc doclint fixes References #1516 [build] doclint error during build --- .../net/sourceforge/pmd/ant/CPDTaskTest.java | 2 +- .../sourceforge/pmd/cpd/XMLRendererTest.java | 2 +- .../pmd/stat/StatisticalRuleTest.java | 42 +++++++++---------- .../java/net/sourceforge/pmd/cli/CLITest.java | 2 +- .../pmd/lang/java/ast/ParserCornersTest.java | 5 +-- .../java/net/sourceforge/pmd/cli/CLITest.java | 2 +- .../pmd/lang/jsp/ast/JspDocStyleTest.java | 42 +++++++++---------- .../pmd/lang/jsp/ast/OpenTagRegisterTest.java | 10 ++--- 8 files changed, 52 insertions(+), 55 deletions(-) diff --git a/pmd-core/src/test/java/net/sourceforge/pmd/ant/CPDTaskTest.java b/pmd-core/src/test/java/net/sourceforge/pmd/ant/CPDTaskTest.java index 606ab5787f..2fba456462 100644 --- a/pmd-core/src/test/java/net/sourceforge/pmd/ant/CPDTaskTest.java +++ b/pmd-core/src/test/java/net/sourceforge/pmd/ant/CPDTaskTest.java @@ -15,7 +15,7 @@ import org.junit.Test; /** * - * @author Romain Pelisse + * @author Romain Pelisse <belaran@gmail.com> * */ public class CPDTaskTest { diff --git a/pmd-core/src/test/java/net/sourceforge/pmd/cpd/XMLRendererTest.java b/pmd-core/src/test/java/net/sourceforge/pmd/cpd/XMLRendererTest.java index d1c076fd84..d59e1c7eca 100644 --- a/pmd-core/src/test/java/net/sourceforge/pmd/cpd/XMLRendererTest.java +++ b/pmd-core/src/test/java/net/sourceforge/pmd/cpd/XMLRendererTest.java @@ -21,7 +21,7 @@ import org.w3c.dom.NodeList; /** * @author Philippe T'Seyen - * @author Romain Pelisse + * @author Romain Pelisse <belaran@gmail.com> * */ public class XMLRendererTest { diff --git a/pmd-core/src/test/java/net/sourceforge/pmd/stat/StatisticalRuleTest.java b/pmd-core/src/test/java/net/sourceforge/pmd/stat/StatisticalRuleTest.java index 481997e3c4..b243672620 100644 --- a/pmd-core/src/test/java/net/sourceforge/pmd/stat/StatisticalRuleTest.java +++ b/pmd-core/src/test/java/net/sourceforge/pmd/stat/StatisticalRuleTest.java @@ -55,31 +55,31 @@ import junit.framework.AssertionFailedError; /** * This class tests the Statistical Rules in PMD. - *

- * The idea is, that we fill up 999 datapoints into the Stat Rule, and then - * throw random parameters at it. - *

- * The three parameters which are checked are: sigma - # Sigmas over the mean. + * + *

The idea is, that we fill up 999 datapoints into the Stat Rule, and then + * throw random parameters at it.

+ * + *

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 - *

- * When more than one parameter is lumped together, then we expect the one which - * would return the fewest to determine what gets sent back. - *

- * So, we throw each collection of parameters, where each one is a different + * better

+ * + *

When more than one parameter is lumped together, then we expect the one which + * would return the fewest to determine what gets sent back.

+ * + *

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. - *

- * If you are going to work with StatisticalRule any, please bump the + * should be.

+ * + *

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.) - *

- * Note also, that when verifying the Sigma, I wasn't quite able to determine + * easier (when we aren't touching the file.)

+ * + *

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.

*/ public class StatisticalRuleTest { @@ -226,9 +226,9 @@ public class StatisticalRuleTest { /** * This returns the expected number of reports. - *

- * If the Minimum comes in at 521.569 then we expect 522, 523, ... 999 will - * pass. + * + *

If the Minimum comes in at 521.569 then we expect 522, 523, ... 999 will + * pass.

*/ public int expectedMinimum(double minimum) { Double d = Double.valueOf(minimum); diff --git a/pmd-java/src/test/java/net/sourceforge/pmd/cli/CLITest.java b/pmd-java/src/test/java/net/sourceforge/pmd/cli/CLITest.java index e6fded25f5..f684597715 100644 --- a/pmd-java/src/test/java/net/sourceforge/pmd/cli/CLITest.java +++ b/pmd-java/src/test/java/net/sourceforge/pmd/cli/CLITest.java @@ -15,7 +15,7 @@ import org.junit.Test; import net.sourceforge.pmd.util.FileUtil; /** - * @author Romain Pelisse + * @author Romain Pelisse <belaran@gmail.com> * */ public class CLITest extends BaseCLITest { diff --git a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/ast/ParserCornersTest.java b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/ast/ParserCornersTest.java index a71ab7869b..c06e00a11a 100644 --- a/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/ast/ParserCornersTest.java +++ b/pmd-java/src/test/java/net/sourceforge/pmd/lang/java/ast/ParserCornersTest.java @@ -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() { diff --git a/pmd-javascript/src/test/java/net/sourceforge/pmd/cli/CLITest.java b/pmd-javascript/src/test/java/net/sourceforge/pmd/cli/CLITest.java index 51b382e633..a4a28514c7 100644 --- a/pmd-javascript/src/test/java/net/sourceforge/pmd/cli/CLITest.java +++ b/pmd-javascript/src/test/java/net/sourceforge/pmd/cli/CLITest.java @@ -13,7 +13,7 @@ import org.junit.Test; import net.sourceforge.pmd.util.FileUtil; /** - * @author Romain Pelisse + * @author Romain Pelisse <belaran@gmail.com> * */ public class CLITest extends BaseCLITest { diff --git a/pmd-jsp/src/test/java/net/sourceforge/pmd/lang/jsp/ast/JspDocStyleTest.java b/pmd-jsp/src/test/java/net/sourceforge/pmd/lang/jsp/ast/JspDocStyleTest.java index 5a0e7c92c1..fe9d225b1e 100644 --- a/pmd-jsp/src/test/java/net/sourceforge/pmd/lang/jsp/ast/JspDocStyleTest.java +++ b/pmd-jsp/src/test/java/net/sourceforge/pmd/lang/jsp/ast/JspDocStyleTest.java @@ -143,7 +143,7 @@ public class JspDocStyleTest extends AbstractJspNodesTst { } /** - * Test parsing of HTML