8247815: doclint: recategorize "no description for ..." as MISSING, not SYNTAX

Reviewed-by: prappo
2026-01-28 03:58:21 +00:00 · 2020-06-19 11:04:52 -07:00 · 2020-06-19 11:04:52 -07:00 · 8b6d3147fb
commit 8b6d3147fb
parent 2e6923ffd6
13 changed files with 44 additions and 40 deletions
--- a/src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java
+++ b/src/jdk.compiler/share/classes/com/sun/tools/doclint/Checker.java
@ -1168,7 +1168,7 @@ public class Checker extends DocTreePathScanner<Void, Void> {
                    return;
            }
        }
-        env.messages.warning(SYNTAX, tree, "dc.empty", tree.getKind().tagName);
+        env.messages.warning(MISSING, tree, "dc.empty", tree.getKind().tagName);
    }

    boolean hasNonWhitespace(TextTree tree) {
--- a/test/langtools/jdk/javadoc/tool/doclint/DocLintTest.java
+++ b/test/langtools/jdk/javadoc/tool/doclint/DocLintTest.java
@ -23,7 +23,7 @@

 /*
 * @test
- * @bug 8004834 8007610 8129909 8182765
+ * @bug 8004834 8007610 8129909 8182765 8247815
 * @summary Add doclint support into javadoc
 * @modules jdk.compiler/com.sun.tools.javac.main
 */
@ -178,7 +178,7 @@ public class DocLintTest {
                    Main.Result.OK,
                    EnumSet.of(Message.DL_WRN12));

-            test(List.of(htmlVersion, rawDiags, "-Xdoclint:syntax"),
+            test(List.of(htmlVersion, rawDiags, "-Xdoclint:missing"),
                    Main.Result.OK,
                    EnumSet.of(Message.DL_WRN12));

@ -186,7 +186,7 @@ public class DocLintTest {
                    Main.Result.ERROR,
                    EnumSet.of(Message.DL_ERR6, Message.DL_ERR9, Message.DL_WRN12));

-            test(List.of(htmlVersion, rawDiags, "-Xdoclint:syntax", "-private"),
+            test(List.of(htmlVersion, rawDiags, "-Xdoclint:missing,syntax", "-private"),
                    Main.Result.ERROR,
                    EnumSet.of(Message.DL_ERR6, Message.DL_WRN12));

--- a/test/langtools/tools/doclint/EmptyAuthorTest.java
+++ b/test/langtools/tools/doclint/EmptyAuthorTest.java
@ -1,11 +1,11 @@
 /*
 * @test /nodynamiccopyright/
- * @bug 8004832
+ * @bug 8004832 8247815
 * @summary Add new doclint package
 * @modules jdk.compiler/com.sun.tools.doclint
 * @build DocLintTester
- * @run main DocLintTester -Xmsgs:-syntax EmptyAuthorTest.java
- * @run main DocLintTester -Xmsgs:syntax -ref EmptyAuthorTest.out EmptyAuthorTest.java
+ * @run main DocLintTester -Xmsgs:-missing EmptyAuthorTest.java
+ * @run main DocLintTester -Xmsgs:missing -ref EmptyAuthorTest.out EmptyAuthorTest.java
 */

 /** @author */
--- a/test/langtools/tools/doclint/EmptyExceptionTest.java
+++ b/test/langtools/tools/doclint/EmptyExceptionTest.java
@ -1,15 +1,15 @@
 /*
 * @test /nodynamiccopyright/
- * @bug 8004832
+ * @bug 8004832 8247815
 * @summary Add new doclint package
 * @modules jdk.compiler/com.sun.tools.doclint
 * @build DocLintTester
- * @run main DocLintTester -Xmsgs:-syntax EmptyExceptionTest.java
- * @run main DocLintTester -Xmsgs:syntax -ref EmptyExceptionTest.out EmptyExceptionTest.java
+ * @run main DocLintTester -Xmsgs:-missing EmptyExceptionTest.java
+ * @run main DocLintTester -Xmsgs:missing -ref EmptyExceptionTest.out EmptyExceptionTest.java
 */

 /** . */
 public class EmptyExceptionTest {
    /** @exception NullPointerException */
-    int emptyException() throws NullPointerException { }
+    void emptyException() throws NullPointerException { }
 }
--- a/test/langtools/tools/doclint/EmptyParamTest.java
+++ b/test/langtools/tools/doclint/EmptyParamTest.java
@ -1,15 +1,15 @@
 /*
 * @test /nodynamiccopyright/
- * @bug 8004832
+ * @bug 8004832 8247815
 * @summary Add new doclint package
 * @modules jdk.compiler/com.sun.tools.doclint
 * @build DocLintTester
- * @run main DocLintTester -Xmsgs:-syntax EmptyParamTest.java
- * @run main DocLintTester -Xmsgs:syntax -ref EmptyParamTest.out EmptyParamTest.java
+ * @run main DocLintTester -Xmsgs:-missing EmptyParamTest.java
+ * @run main DocLintTester -Xmsgs:missing -ref EmptyParamTest.out EmptyParamTest.java
 */

 /** . */
 public class EmptyParamTest {
    /** @param i */
-    int emptyParam(int i) { }
+    void emptyParam(int i) { }
 }
--- a/test/langtools/tools/doclint/EmptyReturnTest.java
+++ b/test/langtools/tools/doclint/EmptyReturnTest.java
@ -1,15 +1,15 @@
 /*
 * @test /nodynamiccopyright/
- * @bug 8004832
+ * @bug 8004832 8247815
 * @summary Add new doclint package
 * @modules jdk.compiler/com.sun.tools.doclint
 * @build DocLintTester
- * @run main DocLintTester -Xmsgs:-syntax EmptyReturnTest.java
- * @run main DocLintTester -Xmsgs:syntax -ref EmptyReturnTest.out EmptyReturnTest.java
+ * @run main DocLintTester -Xmsgs:-missing EmptyReturnTest.java
+ * @run main DocLintTester -Xmsgs:missing -ref EmptyReturnTest.out EmptyReturnTest.java
 */

 /** . */
 public class EmptyReturnTest {
    /** @return */
-    int emptyReturn() { }
+    int emptyReturn() { return 0; }
 }
--- a/test/langtools/tools/doclint/EmptySerialDataTest.java
+++ b/test/langtools/tools/doclint/EmptySerialDataTest.java
@ -1,11 +1,11 @@
 /*
 * @test /nodynamiccopyright/
- * @bug 8004832
+ * @bug 8004832 8247815
 * @summary Add new doclint package
 * @modules jdk.compiler/com.sun.tools.doclint
 * @build DocLintTester
- * @run main DocLintTester -Xmsgs:-syntax EmptySerialDataTest.java
- * @run main DocLintTester -Xmsgs:syntax -ref EmptySerialDataTest.out EmptySerialDataTest.java
+ * @run main DocLintTester -Xmsgs:-missing EmptySerialDataTest.java
+ * @run main DocLintTester -Xmsgs:missing -ref EmptySerialDataTest.out EmptySerialDataTest.java
 */

 import java.io.ObjectOutputStream;
@ -13,6 +13,10 @@ import java.io.Serializable;

 /** . */
 public class EmptySerialDataTest implements Serializable {
-    /** @serialData */
+    /**
+     * .
+     * @serialData
+     * @param s .
+     */
    private void writeObject(ObjectOutputStream s) { }
 }
--- a/test/langtools/tools/doclint/EmptySerialDataTest.out
+++ b/test/langtools/tools/doclint/EmptySerialDataTest.out
@ -1,5 +1,5 @@
-EmptySerialDataTest.java:16: warning: no description for @serialData
-    /** @serialData */
-        ^
+EmptySerialDataTest.java:18: warning: no description for @serialData
+     * @serialData
+       ^
 1 warning

--- a/test/langtools/tools/doclint/EmptySerialFieldTest.java
+++ b/test/langtools/tools/doclint/EmptySerialFieldTest.java
@ -1,11 +1,11 @@
 /*
 * @test /nodynamiccopyright/
- * @bug 8004832
+ * @bug 8004832 8247815
 * @summary Add new doclint package
 * @modules jdk.compiler/com.sun.tools.doclint
 * @build DocLintTester
- * @run main DocLintTester -Xmsgs:-syntax EmptySerialFieldTest.java
- * @run main DocLintTester -Xmsgs:syntax -ref EmptySerialFieldTest.out EmptySerialFieldTest.java
+ * @run main DocLintTester -Xmsgs:-missing EmptySerialFieldTest.java
+ * @run main DocLintTester -Xmsgs:missing -ref EmptySerialFieldTest.out EmptySerialFieldTest.java
 */

 import java.io.ObjectStreamField;
--- a/test/langtools/tools/doclint/EmptySinceTest.java
+++ b/test/langtools/tools/doclint/EmptySinceTest.java
@ -1,15 +1,15 @@
 /*
 * @test /nodynamiccopyright/
- * @bug 8004832
+ * @bug 8004832 8247815
 * @summary Add new doclint package
 * @modules jdk.compiler/com.sun.tools.doclint
 * @build DocLintTester
- * @run main DocLintTester -Xmsgs:-syntax EmptySinceTest.java
- * @run main DocLintTester -Xmsgs:syntax -ref EmptySinceTest.out EmptySinceTest.java
+ * @run main DocLintTester -Xmsgs:-missing EmptySinceTest.java
+ * @run main DocLintTester -Xmsgs:missing -ref EmptySinceTest.out EmptySinceTest.java
 */

 /** . */
 public class EmptySinceTest {
    /** @since */
-    int emptySince() { }
+    void emptySince() { }
 }
--- a/test/langtools/tools/doclint/EmptyVersionTest.java
+++ b/test/langtools/tools/doclint/EmptyVersionTest.java
@ -1,15 +1,15 @@
 /*
 * @test /nodynamiccopyright/
- * @bug 8004832
+ * @bug 8004832 8247815
 * @summary Add new doclint package
 * @modules jdk.compiler/com.sun.tools.doclint
 * @build DocLintTester
- * @run main DocLintTester -Xmsgs:-syntax EmptyVersionTest.java
- * @run main DocLintTester -Xmsgs:syntax -ref EmptyVersionTest.out EmptyVersionTest.java
+ * @run main DocLintTester -Xmsgs:-missing EmptyVersionTest.java
+ * @run main DocLintTester -Xmsgs:missing -ref EmptyVersionTest.out EmptyVersionTest.java
 */

 /** . */
 public class EmptyVersionTest {
    /** @version */
-    int missingVersion() { }
+    void missingVersion() { }
 }
--- a/test/langtools/tools/doclint/MultipleDocLintOptionsTest.java
+++ b/test/langtools/tools/doclint/MultipleDocLintOptionsTest.java
@ -1,8 +1,8 @@
 /*
 * @test /nodynamiccopyright/
- * @bug 8198552
+ * @bug 8198552 8247815
 * @summary Check that -Xdoclint: option can be specified multiple times
- * @compile/fail/ref=MultipleDocLintOptionsTest.out -Xdoclint:html -Xdoclint:syntax -XDrawDiagnostics MultipleDocLintOptionsTest.java
+ * @compile/fail/ref=MultipleDocLintOptionsTest.out -Xdoclint:html -Xdoclint:missing -XDrawDiagnostics MultipleDocLintOptionsTest.java
 */

 /** <html> */
--- a/test/langtools/tools/javac/doclint/DocLintTest.java
+++ b/test/langtools/tools/javac/doclint/DocLintTest.java
@ -135,7 +135,7 @@ public class DocLintTest {
                    Main.Result.OK,
                    EnumSet.of(Message.DL_WRN12));

-            test(Arrays.asList(rawDiags, "-Xdoclint:syntax"),
+            test(Arrays.asList(rawDiags, "-Xdoclint:syntax,missing"),
                    Main.Result.ERROR,
                    EnumSet.of(Message.DL_ERR6, Message.DL_WRN12));