archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-09-15 08:34:30 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8271159: [REDO] JDK-8249634 doclint should report implicit constructor as missing javadoc comments

Browse source 
Reviewed-by: darcy
This commit is contained in:
Jonathan Gibbons 2021-08-11 18:03:40 +00:00
parent 619422764d
commit ec8d3badc8
77 changed files with 236 additions and 115 deletions
Download patch file Download diff file Expand all files Collapse all files

20
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclint/Checker.java
View file

@ -182,10 +182,18 @@ public class Checker extends DocTreePathScanner<Void, Void> {
reportMissing("dc.missing.comment");
return null;
}
} else {
if (tree == null) {
if (!isSynthetic() && !isOverridingMethod)
if (isDefaultConstructor()) {
if (isNormalClass(p.getParentPath())) {
reportMissing("dc.default.constructor");
}
} else if (!isOverridingMethod) {
reportMissing("dc.missing.comment");
}
return null;
}
}
@ -1142,7 +1150,7 @@ public class Checker extends DocTreePathScanner<Void, Void> {
|| env.types.isAssignable(t, env.java_lang_RuntimeException));
}
private boolean isSynthetic() {
private boolean isDefaultConstructor() {
switch (env.currElement.getKind()) {
case CONSTRUCTOR:
// A synthetic default constructor has the same pos as the
@ -1153,6 +1161,14 @@ public class Checker extends DocTreePathScanner<Void, Void> {
return false;
}
private boolean isNormalClass(TreePath p) {
return switch (p.getLeaf().getKind()) {
case ENUM, RECORD -> false;
case CLASS -> true;
default -> throw new IllegalArgumentException(p.getLeaf().getKind().name());
};
}
void markEnclosingTag(Flag flag) {
TagStackItem top = tagStack.peek();
if (top != null)

3
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclint/resources/doclint.properties
View file

@ -1,5 +1,5 @@
#
# Copyright (c) 2012, 2020, Oracle and/or its affiliates. All rights reserved.
# Copyright (c) 2012, 2021, Oracle and/or its affiliates. All rights reserved.
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# This code is free software; you can redistribute it and/or modify it
@ -37,6 +37,7 @@ dc.attr.table.border.not.number = invalid value for attribute "border": {0}
dc.attr.unknown = unknown attribute: {0}
dc.bad.option = bad option: {0}
dc.bad.value.for.option = bad value for option: {0} {1}
dc.default.constructor = use of default constructor, which does not provide a comment
dc.empty = no description for @{0}
dc.entity.invalid = invalid entity &{0};
dc.exception.not.thrown = exception not thrown: {0}

1
test/langtools/jdk/javadoc/doclet/testDiagsLineCaret/TestDiagsLineCaret.java
View file

@ -62,6 +62,7 @@ public class TestDiagsLineCaret extends JavadocTester {
"-XDaccessInternalAPI",
"-tagletpath", testClasses,
"-taglet", "MyTaglet",
"-Xdoclint:none",
"MyClass.java");
checkExit(Exit.ERROR);

6
test/langtools/jdk/javadoc/doclet/testDocTreeDiags/TestDocTreeDiags.java
View file

@ -181,7 +181,11 @@ public class TestDocTreeDiags extends JavadocTester {
fm.setLocationFromPaths(DocumentationTool.Location.DOCUMENTATION_OUTPUT, List.of(outDir));
fm.setLocationFromPaths(DocumentationTool.Location.TAGLET_PATH, List.of(Path.of(System.getProperty("test.classes"))));
Iterable<? extends JavaFileObject> files = Collections.emptyList();
Iterable<String> options = List.of("-taglet", MyTaglet.class.getName(), "-XDaccessInternalAPI", "p");
Iterable<String> options = List.of(
"-taglet", MyTaglet.class.getName(),
"-XDaccessInternalAPI",
"-Xdoclint:all,-missing",
"p");
DocumentationTool.DocumentationTask t = tool.getTask(writer, fm, dl, null, options, files);
checking("exit");

2
test/langtools/jdk/javadoc/doclet/testJavaFX/TestJavaFX.java
View file

@ -420,7 +420,7 @@ public class TestJavaFX extends JavadocTester {
"--javafx",
"--disable-javafx-strict-checks",
"--no-platform-links",
"-Xdoclint:all",
"-Xdoclint:all,-missing",
"--source-path", "src5",
"pkg");
checkExit(Exit.OK);

15
test/langtools/jdk/javadoc/doclet/testMissingComment/TestMissingComment.java
View file

@ -49,11 +49,13 @@ public class TestMissingComment extends JavadocTester {
public void testClass(Path base) throws Exception {
test(base.resolve("class"), """
// no doc comment
public class C { }
public class C {
/** . */ C() { }
}
""",
"""
testClass/class/src/C.java:2: warning: no comment
public class C { }
public class C {
^
""");
}
@ -65,6 +67,7 @@ public class TestMissingComment extends JavadocTester {
public class C {
// no doc comment
public void m() { }
/** . */ C() { }
}
""",
"""
@ -81,6 +84,7 @@ public class TestMissingComment extends JavadocTester {
public class C {
// no doc comment
public int f;
/** . */ C() { }
}
""",
"""
@ -96,12 +100,15 @@ public class TestMissingComment extends JavadocTester {
/** Class comment. */
public class C {
// no doc comment
public class Nested { }
public class Nested {
/** . */ Nested() { }
}
/** . */ C() { }
}
""",
"""
testNested/nest/src/C.java:4: warning: no comment
public class Nested { }
public class Nested {
^
""");
}

6
test/langtools/jdk/javadoc/tool/doclint/DocLintTest.java
View file

@ -63,7 +63,7 @@ public class DocLintTest {
final String code =
/* 01 */ "/** Class comment. */\n" +
/* 02 */ "public class Test {\n" +
/* 02 */ "public class Test { /** */ Test() { }\n" +
/* 03 */ " /** Method comment. */\n" +
/* 04 */ " public void method() { }\n" +
/* 05 */ "\n" +
@ -85,14 +85,14 @@ public class DocLintTest {
final String p1Code =
/* 01 */ "package p1;\n" +
/* 02 */ "public class P1Test {\n" +
/* 02 */ "public class P1Test { /** */ P1Test() { }\n" +
/* 03 */ " /** Syntax < error. */\n" +
/* 04 */ " public void method() { }\n" +
/* 05 */ "}\n";
final String p2Code =
/* 01 */ "package p2;\n" +
/* 02 */ "public class P2Test {\n" +
/* 02 */ "public class P2Test { /** */ P2Test() { }\n" +
/* 03 */ " /** Syntax < error. */\n" +
/* 04 */ " public void method() { }\n" +
/* 05 */ "}\n";

4
test/langtools/tools/doclint/AccessTest.java
View file

@ -19,7 +19,7 @@
*/
/** */
public class AccessTest {
public class AccessTest { /** */ AccessTest() { }
/**
* public a < b
*/
@ -42,7 +42,7 @@ public class AccessTest {
}
/** */
class AccessTest2 {
class AccessTest2 { /** */ AccessTest2() { }
/**
* public a < b
*/

4
test/langtools/tools/doclint/AccessibilityTest.java
View file

@ -4,8 +4,8 @@
* @summary Add new doclint package
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs:-accessibility AccessibilityTest.java
* @run main DocLintTester -ref AccessibilityTest.out AccessibilityTest.java
* @run main DocLintTester -Xmsgs:all,-missing,-accessibility AccessibilityTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref AccessibilityTest.out AccessibilityTest.java
*/
/** */

2
test/langtools/tools/doclint/AnchorTest.java
View file

@ -4,7 +4,7 @@
* @summary Add new doclint package
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref AnchorTest.out AnchorTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref AnchorTest.out AnchorTest.java
*/
/** */

4
test/langtools/tools/doclint/AnchorTest2.java
View file

@ -4,8 +4,8 @@
* @summary doclint doesn't reset HTML anchors correctly
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref AnchorTest2.out AnchorTest2.java AnchorTest2a.java
* @run main DocLintTester -ref AnchorTest2.out AnchorTest2a.java AnchorTest2.java
* @run main DocLintTester -Xmsgs:all,-missing -ref AnchorTest2.out AnchorTest2.java AnchorTest2a.java
* @run main DocLintTester -Xmsgs:all,-missing -ref AnchorTest2.out AnchorTest2a.java AnchorTest2.java
*/
/** */

2
test/langtools/tools/doclint/CrashInAnnotateTest.java
View file

@ -2,7 +2,7 @@
* @test /nodynamiccopyright/
* @bug 8266082
* @summary javac should not crash when seeing type annotations in links
* @compile/fail/ref=CrashInAnnotateTest.out -Xdoclint -XDrawDiagnostics CrashInAnnotateTest.java
* @compile/fail/ref=CrashInAnnotateTest.out -Xdoclint:all,-missing -XDrawDiagnostics CrashInAnnotateTest.java
*/
import java.util.List;

6
test/langtools/tools/doclint/CrashInAnnotateTest.out
View file

@ -1,11 +1,7 @@
CrashInAnnotateTest.java:10:5: compiler.err.proc.messager: annotations not allowed
CrashInAnnotateTest.java:11:5: compiler.err.proc.messager: syntax error in reference
CrashInAnnotateTest.java:16:5: compiler.err.proc.messager: annotations not allowed
CrashInAnnotateTest.java:18:10: compiler.warn.proc.messager: no comment
CrashInAnnotateTest.java:21:5: compiler.err.proc.messager: syntax error in reference
CrashInAnnotateTest.java:24:5: compiler.err.proc.messager: syntax error in reference
CrashInAnnotateTest.java:25:5: compiler.err.proc.messager: syntax error in reference
CrashInAnnotateTest.java:28:5: compiler.warn.proc.messager: no comment
CrashInAnnotateTest.java:29:16: compiler.warn.proc.messager: no comment
6 errors
3 warnings
6 errors

1
test/langtools/tools/doclint/CustomTagTest.java
View file

@ -17,5 +17,6 @@
* @unknownTag Text for an unknown tag.
*/
public class CustomTagTest {
/** */ CustomTagTest() { }
}

4
test/langtools/tools/doclint/DuplicateParamTest.java
View file

@ -4,8 +4,8 @@
* @summary Validate parameter names uniqueness
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs:-reference DuplicateParamTest.java
* @run main DocLintTester -ref DuplicateParamTest.out DuplicateParamTest.java
* @run main DocLintTester -Xmsgs:all,-missing,-reference DuplicateParamTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref DuplicateParamTest.out DuplicateParamTest.java
*/
/** . */

4
test/langtools/tools/doclint/DuplicateReturnTest.java
View file

@ -4,8 +4,8 @@
* @summary Validate return uniqueness
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs:-reference DuplicateReturnTest.java
* @run main DocLintTester -ref DuplicateReturnTest.out DuplicateReturnTest.java
* @run main DocLintTester -Xmsgs:all,-missing,-reference DuplicateReturnTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref DuplicateReturnTest.out DuplicateReturnTest.java
*/
/** . */

1
test/langtools/tools/doclint/EmptyAuthorTest.java
View file

@ -10,4 +10,5 @@
/** @author */
public class EmptyAuthorTest {
/** */ EmptyAuthorTest() { }
}

2
test/langtools/tools/doclint/EmptyExceptionTest.java
View file

@ -9,7 +9,7 @@
*/
/** . */
public class EmptyExceptionTest {
public class EmptyExceptionTest { /** */ EmptyExceptionTest() { }
/** @exception NullPointerException */
void emptyException() throws NullPointerException { }
}

2
test/langtools/tools/doclint/EmptyParamTest.java
View file

@ -9,7 +9,7 @@
*/
/** . */
public class EmptyParamTest {
public class EmptyParamTest { /** . */ EmptyParamTest() { }
/** @param i */
void emptyParam(int i) { }
}

2
test/langtools/tools/doclint/EmptyReturnTest.java
View file

@ -9,7 +9,7 @@
*/
/** . */
public class EmptyReturnTest {
public class EmptyReturnTest { /** . */ EmptyReturnTest() { }
/** @return */
int emptyReturn() { return 0; }
}

2
test/langtools/tools/doclint/EmptySerialDataTest.java
View file

@ -12,7 +12,7 @@ import java.io.ObjectOutputStream;
import java.io.Serializable;
/** . */
public class EmptySerialDataTest implements Serializable {
public class EmptySerialDataTest implements Serializable { /** . */ EmptySerialDataTest() { }
/**
* .
* @serialData

2
test/langtools/tools/doclint/EmptySerialFieldTest.java
View file

@ -12,7 +12,7 @@ import java.io.ObjectStreamField;
import java.io.Serializable;
/** . */
public class EmptySerialFieldTest implements Serializable {
public class EmptySerialFieldTest implements Serializable { /** . */ EmptySerialFieldTest() { }
/**
* @serialField empty String

2
test/langtools/tools/doclint/EmptySinceTest.java
View file

@ -9,7 +9,7 @@
*/
/** . */
public class EmptySinceTest {
public class EmptySinceTest { /** . */ EmptySinceTest() { }
/** @since */
void emptySince() { }
}

2
test/langtools/tools/doclint/EmptyTagsTest.java
View file

@ -9,7 +9,7 @@
*/
/** . */
public class EmptyTagsTest {
public class EmptyTagsTest { /** . */ EmptyTagsTest() { }
/**
* Comment. <p>
*/

2
test/langtools/tools/doclint/EmptyVersionTest.java
View file

@ -9,7 +9,7 @@
*/
/** . */
public class EmptyVersionTest {
public class EmptyVersionTest { /** . */ EmptyVersionTest() { }
/** @version */
void missingVersion() { }
}

4
test/langtools/tools/doclint/EndTagsTest.java
View file

@ -4,8 +4,8 @@
* @summary doclint: structural issue hidden
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs:-html EndTagsTest.java
* @run main DocLintTester -ref EndTagsTest.out EndTagsTest.java
* @run main DocLintTester -Xmsgs:all,-missing,-html EndTagsTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref EndTagsTest.out EndTagsTest.java
*/
/** */

3
test/langtools/tools/doclint/EndWithIdentifierTest.java
View file

@ -29,5 +29,8 @@ public class EndWithIdentifierTest {
/**<a name*/
private void attribute() {}
/** . */
EndWithIdentifierTest() { }
}

4
test/langtools/tools/doclint/HtmlAttrsTest.java
View file

@ -4,8 +4,8 @@
* @summary Add new doclint package
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs:-html HtmlAttrsTest.java
* @run main DocLintTester -ref HtmlAttrsTest.out HtmlAttrsTest.java
* @run main DocLintTester -Xmsgs:all,-missing,-html HtmlAttrsTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref HtmlAttrsTest.out HtmlAttrsTest.java
*/
/** */

4
test/langtools/tools/doclint/HtmlTagsTest.java
View file

@ -4,8 +4,8 @@
* @summary Add new doclint package
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs:-html HtmlTagsTest.java
* @run main DocLintTester -ref HtmlTagsTest.out HtmlTagsTest.java
* @run main DocLintTester -Xmsgs:all,-missing,-html HtmlTagsTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref HtmlTagsTest.out HtmlTagsTest.java
*/
/** */

6
test/langtools/tools/doclint/LambdaTest.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -27,7 +27,7 @@
* @summary ignore declarations in lambda expressions
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs:all SyntheticTest.java
* @run main DocLintTester -Xmsgs:all LambdaTest.java
*/
package acme;
@ -41,6 +41,8 @@ import java.util.function.Function;
*/
public final class LambdaTest
{
/** */ LambdaTest() { }
/**
* The field itself has docs.
*/

3
test/langtools/tools/doclint/LiteralTest.java
View file

@ -14,4 +14,7 @@ public class LiteralTest {
/** <code> abc {@code < & > } def </code> */
public void bad_code_in_code() { }
/** */
LiteralTest() { }
}

3
test/langtools/tools/doclint/MissingThrowsTest.java
View file

@ -12,4 +12,7 @@
public class MissingThrowsTest {
/** */
void missingThrows() throws Exception { }
/** */
MissingThrowsTest() { }
}

3
test/langtools/tools/doclint/MultipleDocLintOptionsTest.java
View file

@ -9,4 +9,7 @@
public class MultipleDocLintOptionsTest {
/** @return */
int emptyReturn() { return -1; }
/** */
MultipleDocLintOptionsTest() { }
}

26
test/langtools/tools/doclint/NoArgsConstructorTest.java Normal file
View file

@ -0,0 +1,26 @@
/*
* @test /nodynamiccopyright/
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs:-missing NoArgsConstructorTest.java
* @run main DocLintTester -Xmsgs:missing/protected -ref NoArgsConstructorTest.out NoArgsConstructorTest.java
*/
/** Main Comment. */
public class NoArgsConstructorTest {
// default constructor
/** PublicConstructor comment. */
public static class PublicConstructor {
public PublicConstructor() { }
}
/** PrivateConstructor comment. */
public static class PrivateConstructor {
private PrivateConstructor() { }
}
/** PublicInterface comment. */
public interface PublicInterface {
}
}

7
test/langtools/tools/doclint/NoArgsConstructorTest.out Normal file
View file

@ -0,0 +1,7 @@
NoArgsConstructorTest.java:10: warning: use of default constructor, which does not provide a comment
public class NoArgsConstructorTest {
^
NoArgsConstructorTest.java:15: warning: no comment
public PublicConstructor() { }
^
2 warnings

9
test/langtools/tools/doclint/OverridesTest.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2015, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -59,36 +59,43 @@ abstract class C1 {
* @return an int
*/
int m(int p) throws Exception;
/** . */ C1() { }
}
/** An implementing class. */
class C2 implements I1 {
int m(int p) throws Exception { return p; }
/** . */ C2() { }
}
/** An extending class. */
class C3 extends C1 {
int m(int p) throws Exception { return p; }
/** . */ C3() { }
}
/** An extending and implementing class. */
class C4 extends C1 implements I1 {
int m(int p) throws Exception { return p; }
/** . */ C4() { }
}
/** An implementing class using inheritdoc. */
class C5 implements I1 {
/** {@inheritDoc} */
int m(int p) throws Exception { return p; }
/** . */ C5() { }
}
/** An implementing class with incomplete documentation. */
class C6 implements I1 {
/** Overriding method */
int m(int p) throws Exception { return p; }
/** . */ C6() { }
}
/** A class implementing an inherited interface. */
class C7 implements I2 {
int m(int p) throws Exception { return p; }
/** . */ C7() { }
}

5
test/langtools/tools/doclint/ParaTagTest.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2013, 2015, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2013, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -53,4 +53,7 @@ public class ParaTagTest {
* </pre>
*/
public void z() {}
/** . */
ParaTagTest() { }
}

2
test/langtools/tools/doclint/ProvidesTest.java
View file

@ -4,7 +4,7 @@
* @summary Module summary page should display information based on "api" or "detail" mode.
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref ProvidesTest.out ProvidesTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref ProvidesTest.out ProvidesTest.java
*/
/**

7
test/langtools/tools/doclint/ReferenceTest.java
View file

@ -18,7 +18,7 @@ public class ReferenceTest {
/**
* @param x description
*/
public class InvalidParam { }
public class InvalidParam { /** . */ private InvalidParam() { } }
/**
* @param x description
@ -28,7 +28,7 @@ public class ReferenceTest {
/**
* @param <X> description
*/
public class typaram_name_not_found { }
public class typaram_name_not_found { /** . */ private typaram_name_not_found() { } }
/**
* @see Object#tooStrong()
@ -75,5 +75,8 @@ public class ReferenceTest {
* @see not.Found[]
*/
public void invalid_array_types() { }
/** . */
private ReferenceTest() { }
}

3
test/langtools/tools/doclint/SummaryTest.java
View file

@ -16,4 +16,7 @@ public class SummaryTest {
/** {@summary legal} text {@summary illegal} **/
public void m2() {}
/** . */
private SummaryTest() { }
}

3
test/langtools/tools/doclint/SyntaxTest.java
View file

@ -14,5 +14,8 @@ public class SyntaxTest {
* a < b
*/
public void syntax_error() { }
/** */
private SyntaxTest() { }
}

10
test/langtools/tools/doclint/SyntheticTest.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2015, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -23,22 +23,22 @@
/*
* @test
* @bug 8004832
* @bug 8004832 8249634
* @summary Add new doclint package
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs:all SyntheticTest.java
* @run main DocLintTester -Xmsgs:all -ref SyntheticTest.out SyntheticTest.java
*/
/**
* This is a test that messages are not generated for synthesized elements
* such as default constructors and enum methods.
* such as enum methods, and that a message *is* generated for a default constructor
*/
public class SyntheticTest {
// No explicit constructor implies a default constructor
/** enum E */
enum E {
public enum E {
/** enum member E1 */
E1,
/** enum member E2 */

5
test/langtools/tools/doclint/SyntheticTest.out Normal file
View file

@ -0,0 +1,5 @@
SyntheticTest.java:37: warning: use of default constructor, which does not provide a comment
public class SyntheticTest {
^
1 warning

1
test/langtools/tools/doclint/UnfinishedInlineTagTest.java
View file

@ -14,5 +14,6 @@ import java.util.List;
/**{@link List
*/
public class UnfinishedInlineTagTest {
/** . */ private UnfinishedInlineTagTest() { }
}

2
test/langtools/tools/doclint/UsesTest.java
View file

@ -4,7 +4,7 @@
* @summary Module summary page should display information based on "api" or "detail" mode.
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref UsesTest.out UsesTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref UsesTest.out UsesTest.java
*/
/**

2
test/langtools/tools/doclint/ValueTest.java
View file

@ -4,7 +4,7 @@
* @summary doclint needs to check for valid usage of at-value tag
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref ValueTest.out ValueTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref ValueTest.out ValueTest.java
*/
/** */

6
test/langtools/tools/doclint/anchorTests/p/Test.java
View file

@ -50,5 +50,11 @@ public class Test {
* <a id="okMethod">okMethod again</a>
*/
public void m() { }
/** . */
private Nested() { }
}
/** . */
private Test() { }
}

2
test/langtools/tools/doclint/html/HtmlVersionTagsAttrsTest.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmaxerrs 200 -ref HtmlVersionTagsAttrsTest.out HtmlVersionTagsAttrsTest.java
* @run main DocLintTester -Xmsgs:all,-missing -Xmaxerrs 200 -ref HtmlVersionTagsAttrsTest.out HtmlVersionTagsAttrsTest.java
*/
/**

4
test/langtools/tools/doclint/html/InlineTagsTest.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2013, 2015, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2013, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -28,7 +28,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs -ref InlineTagTest.out InlineTagsTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref InlineTagTest.out InlineTagsTest.java
*/
/** */

2
test/langtools/tools/doclint/html/ListTagsTest.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs -ref ListTagsTest.out ListTagsTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref ListTagsTest.out ListTagsTest.java
*/
/** */

2
test/langtools/tools/doclint/html/OtherTagsTest.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs -ref OtherTagsTest.out OtherTagsTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref OtherTagsTest.out OtherTagsTest.java
*/
/** */

4
test/langtools/tools/doclint/html/TableTagsTest.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2013, 2015, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2013, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -28,7 +28,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs -ref TableTagTest.out TableTagsTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref TableTagTest.out TableTagsTest.java
*/
/** */

2
test/langtools/tools/doclint/html/TagNotAllowed.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref TagNotAllowed.out TagNotAllowed.java
* @run main DocLintTester -Xmsgs:all,-missing -ref TagNotAllowed.out TagNotAllowed.java
*/
/**

2
test/langtools/tools/doclint/html/TextNotAllowed.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref TextNotAllowed.out TextNotAllowed.java
* @run main DocLintTester -Xmsgs:all,-missing -ref TextNotAllowed.out TextNotAllowed.java
*/
/**

2
test/langtools/tools/doclint/html/UnknownTagTest.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -Xmsgs -ref UnknownTagTest.out UnknownTagTest.java
* @run main DocLintTester -Xmsgs:all,-missing -ref UnknownTagTest.out UnknownTagTest.java
*/
/**

4
test/langtools/tools/doclint/packageTests/bad/Test.java
View file

@ -13,5 +13,7 @@
package bad;
/** */
class Test { }
class Test {
/** */ Test() { }
}

2
test/langtools/tools/doclint/tidy/AnchorAlreadyDefined.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref AnchorAlreadyDefined.out AnchorAlreadyDefined.java
* @run main DocLintTester -Xmsgs:all,-missing -ref AnchorAlreadyDefined.out AnchorAlreadyDefined.java
*/
// tidy: Warning: <.*> anchor ".*" already defined

2
test/langtools/tools/doclint/tidy/BadEnd.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref BadEnd.out BadEnd.java
* @run main DocLintTester -Xmsgs:all,-missing -ref BadEnd.out BadEnd.java
*/
// tidy: Warning: <.*> is probably intended as </.*>

2
test/langtools/tools/doclint/tidy/InsertImplicit.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref InsertImplicit.out InsertImplicit.java
* @run main DocLintTester -Xmsgs:all,-missing -ref InsertImplicit.out InsertImplicit.java
*/
// tidy: Warning: inserting implicit <.*>

2
test/langtools/tools/doclint/tidy/InvalidEntity.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref InvalidEntity.out InvalidEntity.java
* @run main DocLintTester -Xmsgs:all,-missing -ref InvalidEntity.out InvalidEntity.java
*/
// tidy: Warning: replacing invalid numeric character reference .*

2
test/langtools/tools/doclint/tidy/InvalidName.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref InvalidName.out InvalidName.java
* @run main DocLintTester -Xmsgs:all,-missing -ref InvalidName.out InvalidName.java
*/
// tidy: Warning: <a> cannot copy name attribute to id

2
test/langtools/tools/doclint/tidy/InvalidTag.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref InvalidTag.out InvalidTag.java
* @run main DocLintTester -Xmsgs:all,-missing -ref InvalidTag.out InvalidTag.java
*/
// tidy: Error: <.*> is not recognized!

2
test/langtools/tools/doclint/tidy/InvalidURI.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref InvalidURI.out InvalidURI.java
* @run main DocLintTester -Xmsgs:all,-missing -ref InvalidURI.out InvalidURI.java
*/
// tidy: Warning: <a> escaping malformed URI reference

2
test/langtools/tools/doclint/tidy/MissingGT.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref MissingGT.out MissingGT.java
* @run main DocLintTester -Xmsgs:all,-missing -ref MissingGT.out MissingGT.java
*/
// tidy: Warning: <.*> missing '>' for end of tag

2
test/langtools/tools/doclint/tidy/MissingTag.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref MissingTag.out MissingTag.java
* @run main DocLintTester -Xmsgs:all,-missing -ref MissingTag.out MissingTag.java
*/
// tidy: Warning: missing <.*>

2
test/langtools/tools/doclint/tidy/NestedTag.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref NestedTag.out NestedTag.java
* @run main DocLintTester -Xmsgs:all,-missing -ref NestedTag.out NestedTag.java
*/
// tidy: Warning: nested emphasis <.*>

2
test/langtools/tools/doclint/tidy/ParaInPre.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref ParaInPre.out ParaInPre.java
* @run main DocLintTester -Xmsgs:all,-missing -ref ParaInPre.out ParaInPre.java
*/
// tidy: Warning: replacing <p> by <br>

2
test/langtools/tools/doclint/tidy/RepeatedAttr.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref RepeatedAttr.out RepeatedAttr.java
* @run main DocLintTester -Xmsgs:all,-missing -ref RepeatedAttr.out RepeatedAttr.java
*/
// tidy: Warning: <.*> dropping value ".*" for repeated attribute ".*"

2
test/langtools/tools/doclint/tidy/TextNotAllowed.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref TextNotAllowed.out TextNotAllowed.java
* @run main DocLintTester -Xmsgs:all,-missing -ref TextNotAllowed.out TextNotAllowed.java
*/
// tidy: Warning: plain text isn't allowed in <.*> elements

2
test/langtools/tools/doclint/tidy/TrimmingEmptyTag.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref TrimmingEmptyTag.out TrimmingEmptyTag.java
* @run main DocLintTester -Xmsgs:all,-missing -ref TrimmingEmptyTag.out TrimmingEmptyTag.java
*/
// tidy: Warning: trimming empty <.*>

2
test/langtools/tools/doclint/tidy/UnescapedOrUnknownEntity.java
View file

@ -5,7 +5,7 @@
* @library ..
* @modules jdk.javadoc/jdk.javadoc.internal.doclint
* @build DocLintTester
* @run main DocLintTester -ref UnescapedOrUnknownEntity.out UnescapedOrUnknownEntity.java
* @run main DocLintTester -Xmsgs:all,-missing -ref UnescapedOrUnknownEntity.out UnescapedOrUnknownEntity.java
*/
// tidy: Warning: unescaped & or unknown entity ".*"

2
test/langtools/tools/doclint/tool/MaxDiagsTest.java
View file

@ -19,4 +19,6 @@ public class MaxDiagsTest {
/** 4 undocumented signature items */
public int warnings(int a1, int a2) throws Exception { return 0; }
/** */ MaxDiagsTest() { }
}

2
test/langtools/tools/doclint/tool/StatsTest.java
View file

@ -17,4 +17,6 @@ public class StatsTest {
/** 4 undocumented signature items */
public int warnings(int a1, int a2) throws Exception { return 0; }
/** */ StatsTest() { }
}

4
test/langtools/tools/javac/doclint/DocLintFormatTest.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -73,7 +73,7 @@ public class DocLintFormatTest {
System.err.println("Test: " + file);
List<String> output = new JavacTask(tb)
.outdir(classes)
.options("-XDrawDiagnostics", "-Xdoclint")
.options("-XDrawDiagnostics", "-Xdoclint:all,-missing")
.files(file)
.run(expect.length == 0 ? Task.Expect.SUCCESS : Task.Expect.FAIL)
.writeAll()

4
test/langtools/tools/javac/doclint/DocLintTest.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -63,7 +63,7 @@ public class DocLintTest {
final String code =
/* 01 */ "/** Class comment. */\n" +
/* 02 */ "public class Test {\n" +
/* 02 */ "public class Test { /** */ Test() { }\n" +
/* 03 */ " /** Method comment. */\n" +
/* 04 */ " public void method() { }\n" +
/* 05 */ "\n" +

62
test/langtools/tools/javac/doclint/IncludePackagesTest.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2015, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -63,29 +63,39 @@ public class IncludePackagesTest {
final String[] sources = new String[] {
"p1/p1T.java",
"package p1;\n" +
"/** Syntax < error. */\n" +
"public class p1T {\n" +
"}\n",
"""
package p1;
/** Syntax < error. */
public class p1T {
}
""",
"p1/sp1/p1sp1T.java",
"package p1.sp1;\n" +
"/** Syntax < error. */\n" +
"public class p1sp1T {\n" +
"}\n",
"""
package p1.sp1;
/** Syntax < error. */
public class p1sp1T {
}
""",
"p1/sp1/sp2/p1sp1sp2T.java",
"package p1.sp1.sp2;\n" +
"/** Syntax < error. */\n" +
"public class p1sp1sp2T {\n" +
"}\n",
"""
package p1.sp1.sp2;
/** Syntax < error. */
public class p1sp1sp2T {
}
""",
"p2/p2T.java",
"package p2;\n" +
"/** Syntax < error. */\n" +
"public class p2T {\n" +
"}\n",
"""
package p2;
/** Syntax < error. */
public class p2T {
}
""",
"Default.java",
"/** Syntax < error. */\n" +
"public class Default {\n" +
"}\n",
"""
/** Syntax < error. */
public class Default {
}
""",
};
final String rawDiags = "-XDrawDiagnostics";
@ -130,28 +140,28 @@ public class IncludePackagesTest {
files.add(new JFOImpl(sources[si], sources[si + 1]));
}
test(Arrays.asList(rawDiags, "-Xdoclint"),
test(Arrays.asList(rawDiags, "-Xdoclint:all,-missing"),
Main.Result.ERROR,
EnumSet.of(Message.p1T, Message.p1sp1T, Message.p1sp1sp2T,
Message.p2T, Message.Default));
test(Arrays.asList(rawDiags, "-Xdoclint", "-Xdoclint/package:p1"),
test(Arrays.asList(rawDiags, "-Xdoclint:all,-missing", "-Xdoclint/package:p1"),
Main.Result.ERROR,
EnumSet.of(Message.p1T));
test(Arrays.asList(rawDiags, "-Xdoclint", "-Xdoclint/package:p1.*"),
test(Arrays.asList(rawDiags, "-Xdoclint:all,-missing", "-Xdoclint/package:p1.*"),
Main.Result.ERROR,
EnumSet.of(Message.p1sp1T, Message.p1sp1sp2T));
test(Arrays.asList(rawDiags, "-Xdoclint", "-Xdoclint/package:p1.*,-p1.sp1"),
test(Arrays.asList(rawDiags, "-Xdoclint:all,-missing", "-Xdoclint/package:p1.*,-p1.sp1"),
Main.Result.ERROR,
EnumSet.of(Message.p1sp1sp2T));
test(Arrays.asList(rawDiags, "-Xdoclint", "-Xdoclint/package:-p1.sp1"),
test(Arrays.asList(rawDiags, "-Xdoclint:all,-missing", "-Xdoclint/package:-p1.sp1"),
Main.Result.ERROR,
EnumSet.of(Message.p1T, Message.p1sp1sp2T, Message.p2T, Message.Default));
test(Arrays.asList(rawDiags, "-Xdoclint", "-Xdoclint/package:wrong+package"),
test(Arrays.asList(rawDiags, "-Xdoclint:all,-missing", "-Xdoclint/package:wrong+package"),
Main.Result.CMDERR,
EnumSet.of(Message.INVALID_PACKAGE_ERROR));

4
test/langtools/tools/javac/doclint/NPEDuplicateClassNamesTest.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2017, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -84,7 +84,7 @@ public class NPEDuplicateClassNamesTest extends TestRunner {
"2 errors");
List<String> output = new JavacTask(tb)
.outdir(classes)
.options("-XDrawDiagnostics", "-Xdoclint:all", "-XDdev")
.options("-XDrawDiagnostics", "-Xdoclint:all,-missing", "-XDdev")
.files(tb.findJavaFiles(src))
.run(Task.Expect.FAIL)
.writeAll()