diff --git a/src/testinputs/com/puppycrawl/tools/checkstyle/javadoc/pkginfo/annotation/package-info.java b/src/testinputs/com/puppycrawl/tools/checkstyle/javadoc/pkginfo/annotation/package-info.java new file mode 100755 index 000000000..d1f174026 --- /dev/null +++ b/src/testinputs/com/puppycrawl/tools/checkstyle/javadoc/pkginfo/annotation/package-info.java @@ -0,0 +1,12 @@ +/** + * This is a valid package documentation. <--- See the period after the + * first sentence. + * + *

+ * hurray for javadocs in html + *
+ * with a legacy non-closed br element + *

+ */ +@java.lang.annotation.Documented +package com.puppycrawl.tools.checkstyle.javadoc.pkginfo.annotation; diff --git a/src/tests/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java b/src/tests/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java index cdcd88dbe..62ebfabee 100755 --- a/src/tests/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java +++ b/src/tests/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java @@ -234,7 +234,7 @@ public class JavadocStyleCheckTest verify(checkConfig, getPath("InputJavadocStyleCheck.java"), expected); } - + @Test public void packageInfoInheritDoc() throws Exception { @@ -245,15 +245,15 @@ public class JavadocStyleCheckTest "1: First sentence should end with a period.", }; - String basePath = "javadoc" + File.separator + + String basePath = "javadoc" + File.separator + "pkginfo" + File.separator + "invalidinherit" + File.separator; - + verify(createChecker(checkConfig), getPath(basePath + "package-info.java"), expected); } - + @Test public void packageInfoInvalid() throws Exception { @@ -264,15 +264,33 @@ public class JavadocStyleCheckTest "1: First sentence should end with a period.", }; - String basePath = "javadoc" + File.separator + + String basePath = "javadoc" + File.separator + "pkginfo" + File.separator + "invalidformat" + File.separator; - + verify(createChecker(checkConfig), getPath(basePath + "package-info.java"), expected); } - + + @Test + public void packageInfoAnnotation() throws Exception + { + final DefaultConfiguration checkConfig = + createCheckConfig(JavadocStyleCheck.class); + final String[] expected = + { + }; + + String basePath = "javadoc" + File.separator + + "pkginfo" + File.separator + + "annotation" + File.separator; + + verify(createChecker(checkConfig), + getPath(basePath + "package-info.java"), + expected); + } + @Test public void packageInfoMissing() throws Exception { @@ -282,15 +300,15 @@ public class JavadocStyleCheckTest { "1: Missing a Javadoc comment." }; - - String basePath = "javadoc" + File.separator + + + String basePath = "javadoc" + File.separator + "bothfiles" + File.separator; - + verify(createChecker(checkConfig), getPath(basePath + "package-info.java"), expected); } - + @Test public void packageInfoValid() throws Exception { @@ -298,10 +316,10 @@ public class JavadocStyleCheckTest createCheckConfig(JavadocStyleCheck.class); final String[] expected = {}; - String basePath = "javadoc" + File.separator + + String basePath = "javadoc" + File.separator + "pkginfo" + File.separator + "valid" + File.separator; - + verify(createChecker(checkConfig), getPath(basePath + "package-info.java"), expected);