Issue #4586: Modified AbstractJavadocCheckTest.java and moved its fil…

…es to the abstractjavadoc subdirectory
checkstyle · Jul 6, 2017 · e14300a · e14300a
1 parent 2729df5
commit e14300a
Show file tree

Hide file tree

Showing 11 changed files with 183 additions and 17 deletions.
diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheckTest.java
@@ -54,7 +54,8 @@ public class AbstractJavadocCheckTest extends BaseCheckTestSupport {
     @Override
     protected String getPath(String filename) throws IOException {
         return super.getPath("checks" + File.separator
-                + "javadoc" + File.separator + filename);
+                + "javadoc" + File.separator 
+                + "abstractjavadoc" + File.separator + filename);
     }
 
     @Test
@@ -65,14 +66,14 @@ public void testNumberFormatException() throws Exception {
                 + "alternative at input '<ul><li>a' {@link EntityEntry} (by way of {@link #;'",
                 "HTML_TAG"),
         };
-        verify(checkConfig, getPath("InputTestNumberFormatException.java"), expected);
+        verify(checkConfig, getPath("InputAbstractJavadocNumberFormatException.java"), expected);
     }
 
     @Test
     public void testCustomTag() throws Exception {
         final DefaultConfiguration checkConfig = createCheckConfig(TempCheck.class);
         final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
-        verify(checkConfig, getPath("InputCustomTag.java"), expected);
+        verify(checkConfig, getPath("InputAbstractJavadocCustomTag.java"), expected);
     }
 
     @Test
@@ -82,7 +83,7 @@ public void testParsingErrors() throws Exception {
             "4: " + getCheckMessage(MSG_JAVADOC_MISSED_HTML_CLOSE, 4, "unclosedTag"),
             "8: " + getCheckMessage(MSG_JAVADOC_WRONG_SINGLETON_TAG, 35, "img"),
         };
-        verify(checkConfig, getPath("InputParsingErrors.java"), expected);
+        verify(checkConfig, getPath("InputAbstractJavadocParsingErrors.java"), expected);
     }
 
     @Test
@@ -96,7 +97,7 @@ public void testWithMultipleChecks() throws Exception {
         checker.setModuleClassLoader(Thread.currentThread().getContextClassLoader());
         checker.configure(checkerConfig);
 
-        verify(checker, getPath("InputCorrectJavaDocParagraph.java"));
+        verify(checker, getPath("InputAbstractJavadocCorrectJavaDocParagraph.java"));
     }
 
     @Test
@@ -105,23 +106,23 @@ public void testAntlrError() throws Exception {
         final String[] expected = {
             "3: " + getCheckMessage(MSG_KEY_UNRECOGNIZED_ANTLR_ERROR, 0, null),
         };
-        verify(checkConfig, getPath("InputTestInvalidAtSeeReference.java"), expected);
+        verify(checkConfig, getPath("InputAbstractJavadocInvalidAtSeeReference.java"), expected);
     }
 
     @Test
     public void testCheckReuseAfterParseErrorWithFollowingAntlrErrorInTwoFiles() throws Exception {
         final DefaultConfiguration checkConfig = createCheckConfig(TempCheck.class);
         final Map<String, List<String>> expectedMessages = new LinkedHashMap<>(2);
-        expectedMessages.put(getPath("InputParsingErrors.java"), asList(
+        expectedMessages.put(getPath("InputAbstractJavadocParsingErrors.java"), asList(
             "4: " + getCheckMessage(MSG_JAVADOC_MISSED_HTML_CLOSE, 4, "unclosedTag"),
             "8: " + getCheckMessage(MSG_JAVADOC_WRONG_SINGLETON_TAG, 35, "img")
         ));
-        expectedMessages.put(getPath("InputTestInvalidAtSeeReference.java"), singletonList(
+        expectedMessages.put(getPath("InputAbstractJavadocInvalidAtSeeReference.java"), singletonList(
             "3: " + getCheckMessage(MSG_KEY_UNRECOGNIZED_ANTLR_ERROR, 0, null)
         ));
         verify(createChecker(checkConfig), new File[] {
-            new File(getPath("InputParsingErrors.java")),
-            new File(getPath("InputTestInvalidAtSeeReference.java")), }, expectedMessages);
+            new File(getPath("InputAbstractJavadocParsingErrors.java")),
+            new File(getPath("InputAbstractJavadocInvalidAtSeeReference.java")), }, expectedMessages);
     }
 
     @Test
@@ -132,7 +133,7 @@ public void testCheckReuseAfterParseErrorWithFollowingAntlrErrorInSingleFile()
             "4: " + getCheckMessage(MSG_JAVADOC_MISSED_HTML_CLOSE, 4, "unclosedTag"),
             "7: " + getCheckMessage(MSG_KEY_UNRECOGNIZED_ANTLR_ERROR, 4, null),
         };
-        verify(checkConfig, getPath("InputTestUnclosedTagAndInvalidAtSeeReference.java"), expected);
+        verify(checkConfig, getPath("InputAbstractJavadocUnclosedTagAndInvalidAtSeeReference.java"), expected);
     }
 
     @Test
@@ -141,7 +142,7 @@ public void testPosition()
         JavadocCatchCheck.clearCounter();
         final DefaultConfiguration checkConfig = createCheckConfig(JavadocCatchCheck.class);
         final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
-        verify(checkConfig, getPath("InputJavadocPosition.java"), expected);
+        verify(checkConfig, getPath("InputAbstractJavadocPosition.java"), expected);
         Assert.assertEquals(58, JavadocCatchCheck.javadocsNumber);
     }
 
@@ -151,7 +152,7 @@ public void testPositionWithSinglelineComments()
         JavadocCatchCheck.clearCounter();
         final DefaultConfiguration checkConfig = createCheckConfig(JavadocCatchCheck.class);
         final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
-        verify(checkConfig, getPath("InputJavadocPositionWithSinglelineComments.java"), expected);
+        verify(checkConfig, getPath("InputAbstractJavadocPositionWithSinglelineComments.java"), expected);
         Assert.assertEquals(58, JavadocCatchCheck.javadocsNumber);
     }
 
@@ -161,7 +162,7 @@ public void testPositionOnlyComments()
         JavadocCatchCheck.clearCounter();
         final DefaultConfiguration checkConfig = createCheckConfig(JavadocCatchCheck.class);
         final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
-        verify(checkConfig, getPath("InputJavadocPositionOnlyComments.java"), expected);
+        verify(checkConfig, getPath("InputAbstractJavadocPositionOnlyComments.java"), expected);
         Assert.assertEquals(0, JavadocCatchCheck.javadocsNumber);
     }
 
@@ -202,7 +203,7 @@ public void testAcceptableTokensFail()
         checkConfig.addAttribute("javadocTokens", "RETURN_LITERAL");
         try {
             final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
-            verify(checkConfig, getPath("InputMain.java"), expected);
+            verify(checkConfig, getPath("InputAbstractJavadocMain.java"), expected);
             Assert.fail("CheckstyleException is expected");
         }
         catch (IllegalStateException ex) {
@@ -220,7 +221,7 @@ public void testAcceptableTokensPass()
         checkConfig.addAttribute("javadocTokens", "DEPRECATED_LITERAL");
 
         final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
-        verify(checkConfig, getPath("InputMain.java"), expected);
+        verify(checkConfig, getPath("InputAbstractJavadocMain.java"), expected);
     }
 
     @Test
@@ -247,7 +248,7 @@ public void testVisitLeaveToken()
         JavadocVisitLeaveCheck.clearCounter();
         final DefaultConfiguration checkConfig = createCheckConfig(JavadocVisitLeaveCheck.class);
         final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
-        verify(checkConfig, getPath("InputJavadocPosition.java"), expected);
+        verify(checkConfig, getPath("InputAbstractJavadocPosition.java"), expected);
         Assert.assertTrue(JavadocVisitLeaveCheck.visitCount > 0);
         Assert.assertEquals(JavadocVisitLeaveCheck.visitCount, JavadocVisitLeaveCheck.leaveCount);
     }

diff --git a/...heckstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocCorrectJavaDocParagraph.java b/...heckstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocCorrectJavaDocParagraph.java
@@ -0,0 +1,112 @@
+package com.puppycrawl.tools.checkstyle.checks.javadoc.abstractjavadoc;
+
+/**
+ * Some Javadoc.
+ *
+ * <p>Some Javadoc.
+ *
+ */
+class InputAbstractJavadocCorrectJavaDocParagraph {
+
+    /**
+     * Some Javadoc.
+     *   
+     * <p>{@code function} will never be invoked with a null value.
+     *
+     * @since 8.0
+     */
+    public static final byte NUL = 0;
+
+    /**
+     * Some Javadoc.
+     *
+     * <p>Some Javadoc.
+     * 
+     * <pre>
+     * class Foo {
+     * 
+     *   void foo() {}
+     * }
+     * </pre>
+     *
+     * @see <a href="http://code.google.com/webtoolkit/doc/latest/DevGuideOrganizingProjects.html#DevGuideModules">
+     *     Documentation about GWT emulated source</a>
+     */
+    boolean emulated() {return false;}
+
+    /**
+     * Some Javadoc.
+     * 
+     *<pre>
+     * Test
+     * </pre>
+     * 
+     * <pre>
+     * Test
+     * </pre>
+     */
+    boolean test() {return false;}
+
+    /**
+     * Some Javadoc.
+     *
+     * <p>Some Javadoc.
+     *
+     */
+     class InnerInputCorrectJavaDocParagraphCheck {
+
+        /**
+         * Some Javadoc.
+         *
+         * <p>Some Javadoc.
+         *
+         * <p>Some Javadoc.
+         *
+         * @since 8.0
+         */
+        public static final byte NUL = 0;
+
+        /**
+         * Some Javadoc.
+         *
+         * <p>Some Javadoc.
+         *
+         * @see <a href="http://code.google.com/webtoolkit/doc/latest/DevGuideOrganizingProjects.html#DevGuideModules">
+         *     Documentation about GWT emulated source</a>
+         */
+        boolean emulated() {return false;}
+    }
+
+    InnerInputCorrectJavaDocParagraphCheck anon = new InnerInputCorrectJavaDocParagraphCheck() {
+
+    	/**
+         * Some Javadoc.
+         *
+         * <p>Some Javadoc.
+         *
+         * <p>Some Javadoc.
+         *
+         * @since 8.0
+         */
+        public static final byte NUL = 0;
+
+        /** 
+         * Some Javadoc with space at the end of first line.
+         *
+         * <p>Some Javadoc.
+         *
+         * <p>Some Javadoc.
+         *
+         * @see <a href="http://code.google.com/webtoolkit/doc/latest/DevGuideOrganizingProjects.html#DevGuideModules">
+         *     Documentation about GWT emulated source</a>
+         */
+        boolean emulated() {return false;}
+    };
+}
+
+/*
+ *  This comment has paragraph without '<p>' tag.
+ *
+ *  It's fine, because this is plain comment.
+ */
+class ClassWithPlainComment {}
diff --git a/...ycrawl/tools/checkstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocCustomTag.java b/...ycrawl/tools/checkstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocCustomTag.java
@@ -0,0 +1,11 @@
+package com.puppycrawl.tools.checkstyle.checks.javadoc.abstractjavadoc;
+
+public class InputAbstractJavadocCustomTag {
+    /**
+     * {@customTag}
+     */
+    void customTag() {}
+
+    /** {@customTag} */
+    void customTag2() {}
+}
diff --git a/.../checkstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocInvalidAtSeeReference.java b/.../checkstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocInvalidAtSeeReference.java
@@ -0,0 +1,7 @@
+package com.puppycrawl.tools.checkstyle.checks.javadoc.abstractjavadoc;
+
+/**
+ * @see javax.swing.tree.DefaultTreeCellRenderer.getTreeCellRendererComponent()
+ */
+class InputAbstractJavadocInvalidAtSeeReference {
+}
diff --git a/.../puppycrawl/tools/checkstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocMain.java b/.../puppycrawl/tools/checkstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocMain.java
@@ -0,0 +1,4 @@
+package com.puppycrawl.tools.checkstyle.checks.javadoc.abstractjavadoc;
+/** Javadoc */
+public class InputAbstractJavadocMain {
+}
diff --git a/.../checkstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocNumberFormatException.java b/.../checkstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocNumberFormatException.java
@@ -0,0 +1,4 @@
+package com.puppycrawl.tools.checkstyle.checks.javadoc.abstractjavadoc;
+
+/** <ul><li>a' {@link EntityEntry} (by way of {@link #;}</li></ul> */
+class InputAbstractJavadocNumberFormatException{}
diff --git a/...wl/tools/checkstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocParsingErrors.java b/...wl/tools/checkstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocParsingErrors.java
@@ -0,0 +1,12 @@
+package com.puppycrawl.tools.checkstyle.checks.javadoc.abstractjavadoc;
+
+/**
+ * <unclosedTag>
+ */
+class InputAbstractJavadocParsingErrors {
+    /**
+     * <img src="singletonTag"/></img>
+     */
+    void singletonTag() {
+    }
+}
diff --git a/.../checks/javadoc/InputJavadocPosition.java → ...javadoc/InputAbstractJavadocPosition.java b/.../checks/javadoc/InputJavadocPosition.java → ...javadoc/InputAbstractJavadocPosition.java
diff --git a/...s/checkstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocPositionOnlyComments.java b/...s/checkstyle/checks/javadoc/abstractjavadoc/InputAbstractJavadocPositionOnlyComments.java
@@ -0,0 +1,3 @@
+package com.puppycrawl.tools.checkstyle.checks.javadoc.abstractjavadoc;
+/** Javadoc for import */
+import java.io.Serializable;
diff --git a/...avadocPositionWithSinglelineComments.java → ...avadocPositionWithSinglelineComments.java b/...avadocPositionWithSinglelineComments.java → ...avadocPositionWithSinglelineComments.java
diff --git a/...ecks/javadoc/abstractjavadoc/InputAbstractJavadocUnclosedTagAndInvalidAtSeeReference.java b/...ecks/javadoc/abstractjavadoc/InputAbstractJavadocUnclosedTagAndInvalidAtSeeReference.java
@@ -0,0 +1,12 @@
+package com.puppycrawl.tools.checkstyle.checks.javadoc.abstractjavadoc;
+
+/**
+ * <unclosedTag>
+ */
+class InputAbstractJavadocUnclosedTagAndInvalidAtSeeReference {
+    /**
+     * @see javax.swing.tree.DefaultTreeCellRenderer.getTreeCellRendererComponent()
+     */
+    void invalidAtSeeReference() {
+    }
+}