Issue checkstyle#12520: removes missing package-info Javadoc check in…

… JavadocStyle
rnveach · Dec 12, 2022 · 9243d47 · 9243d47
1 parent 8382d88
commit 9243d47
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 153 deletions.
diff --git a/config/archunit-store/slices_should_be_free_of_cycles_suppressions b/config/archunit-store/slices_should_be_free_of_cycles_suppressions
diff --git a/src/it/java/org/checkstyle/suppressionxpathfilter/XpathRegressionJavadocStyleTest.java b/src/it/java/org/checkstyle/suppressionxpathfilter/XpathRegressionJavadocStyleTest.java
diff --git a/...eckstyle/suppressionxpathfilter/javadocstyle/SuppressionXpathRegression/package-info.java b/...eckstyle/suppressionxpathfilter/javadocstyle/SuppressionXpathRegression/package-info.java
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java
@@ -66,8 +66,7 @@
  * a previous open tag.
  * </li>
  * <li>
- * Check that a package Javadoc comment is well-formed (as described above) and
- * NOT missing from any package-info.java files.
+ * Check that a package Javadoc comment is well-formed (as described above).
  * </li>
  * <li>
  * Check for allowed HTML tags. The list of allowed HTML tags is
@@ -288,9 +287,6 @@
  * {@code javadoc.incompleteTag}
  * </li>
  * <li>
- * {@code javadoc.missing}
- * </li>
- * <li>
  * {@code javadoc.noPeriod}
  * </li>
  * <li>
@@ -304,9 +300,6 @@
 public class JavadocStyleCheck
     extends AbstractCheck {
 
-    /** Message property key for the Missing Javadoc message. */
-    public static final String MSG_JAVADOC_MISSING = "javadoc.missing";
-
     /** Message property key for the Empty Javadoc message. */
     public static final String MSG_EMPTY = "javadoc.empty";
 
@@ -447,16 +440,7 @@ else if (!ScopeUtil.isInCodeBlock(ast)) {
      * @see #checkHtmlTags(DetailAST, TextBlock)
      */
     private void checkComment(final DetailAST ast, final TextBlock comment) {
-        if (comment == null) {
-            // checking for missing docs in JavadocStyleCheck is not consistent
-            // with the rest of CheckStyle...  Even though, I didn't think it
-            // made sense to make another check just to ensure that the
-            // package-info.java file actually contains package Javadocs.
-            if (CheckUtil.isPackageInfo(getFilePath())) {
-                log(ast, MSG_JAVADOC_MISSING);
-            }
-        }
-        else {
+        if (comment != null) {
             if (checkFirstSentence) {
                 checkFirstSentenceEnding(ast, comment);
             }

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/javadoc/JavadocStyleCheck.xml b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/javadoc/JavadocStyleCheck.xml
@@ -31,8 +31,7 @@
  a previous open tag.
  &lt;/li&gt;
  &lt;li&gt;
- Check that a package Javadoc comment is well-formed (as described above) and
- NOT missing from any package-info.java files.
+ Check that a package Javadoc comment is well-formed (as described above).
  &lt;/li&gt;
  &lt;li&gt;
  Check for allowed HTML tags. The list of allowed HTML tags is

diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java
@@ -23,7 +23,6 @@
 import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_EMPTY;
 import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_EXTRA_HTML;
 import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_INCOMPLETE_TAG;
-import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_JAVADOC_MISSING;
 import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_NO_PERIOD;
 import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_UNCLOSED_HTML;
 
@@ -483,17 +482,6 @@ public void packageInfoAnnotation() throws Exception {
                expected);
     }
 
-    @Test
-    public void packageInfoMissing() throws Exception {
-        final String[] expected = {
-            "16:1: " + getCheckMessage(MSG_JAVADOC_MISSING),
-        };
-
-        verifyWithInlineConfigParser(
-                getPath("bothfiles" + File.separator + "package-info.java"),
-               expected);
-    }
-
     @Test
     public void packageInfoValid() throws Exception {
         final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;

diff --git a/...s/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/bothfiles/package-info.java b/...s/com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle/bothfiles/package-info.java
diff --git a/src/xdocs/config_javadoc.xml b/src/xdocs/config_javadoc.xml
@@ -1519,7 +1519,7 @@ public class TestClass {
           </li>
           <li>
            Check that a package Javadoc comment is well-formed (as
-           described above) and NOT missing from any package-info.java files.
+           described above).
           </li>
           <li>
             Check for allowed HTML tags. The list of allowed HTML tags
@@ -1824,10 +1824,6 @@ public class Test {
             <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fjavadoc+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22javadoc.incompleteTag%22">
             javadoc.incompleteTag</a>
           </li>
-          <li>
-            <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fjavadoc+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22javadoc.missing%22">
-            javadoc.missing</a>
-          </li>
           <li>
             <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%2Fcom%2Fpuppycrawl%2Ftools%2Fcheckstyle%2Fchecks%2Fjavadoc+filename%3Amessages*.properties+repo%3Acheckstyle%2Fcheckstyle+%22javadoc.noPeriod%22">
             javadoc.noPeriod</a>