-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
8314448: Coordinate DocLint and JavaDoc to report on unknown tags
Reviewed-by: jjg
- Loading branch information
1 parent
bcba5e9
commit aecbb1b
Showing
4 changed files
with
176 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
106 changes: 106 additions & 0 deletions
106
test/langtools/jdk/javadoc/doclet/testUknownTags/TestUnknownTags.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| /* | ||
| * Copyright (c) 2023, 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 | ||
| * under the terms of the GNU General Public License version 2 only, as | ||
| * published by the Free Software Foundation. | ||
| * | ||
| * This code is distributed in the hope that it will be useful, but WITHOUT | ||
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | ||
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | ||
| * version 2 for more details (a copy is included in the LICENSE file that | ||
| * accompanied this code). | ||
| * | ||
| * You should have received a copy of the GNU General Public License version | ||
| * 2 along with this work; if not, write to the Free Software Foundation, | ||
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | ||
| * | ||
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | ||
| * or visit www.oracle.com if you need additional information or have any | ||
| * questions. | ||
| */ | ||
|
|
||
| /* | ||
| * @test | ||
| * @bug 8314448 | ||
| * @library /tools/lib ../../lib | ||
| * @modules jdk.compiler/com.sun.tools.javac.api | ||
| * jdk.compiler/com.sun.tools.javac.main | ||
| * jdk.javadoc/jdk.javadoc.internal.tool | ||
| * @build toolbox.ToolBox javadoc.tester.* | ||
| * @run main TestUnknownTags | ||
| */ | ||
|
|
||
| import java.nio.file.Path; | ||
|
|
||
| import javadoc.tester.JavadocTester; | ||
| import toolbox.ToolBox; | ||
|
|
||
| public class TestUnknownTags extends JavadocTester { | ||
|
|
||
| public static void main(String... args) throws Exception { | ||
| new TestUnknownTags().runTests(); | ||
| } | ||
|
|
||
| private final ToolBox tb = new ToolBox(); | ||
|
|
||
| // DocLint or not, there should be exactly one diagnostic message about | ||
| // an unknown tag. No doubled, no "swallowed" messages, just one. | ||
| @Test | ||
| public void testExactlyOneMessage(Path base) throws Exception { | ||
| var src = base.resolve("src"); | ||
| tb.writeJavaFiles(src, """ | ||
| package x; | ||
| /** @mytag */ | ||
| public class MyClass { } | ||
| """); | ||
| // don't check exit status: we don't care if it's an error or warning | ||
|
|
||
| // DocLint is explicit | ||
| int i = 0; | ||
| for (var check : new String[]{":all", ":none", ""}) { | ||
| var outputDir = "out-DocLint-" + i++; // use separate output directories | ||
| javadoc("-Xdoclint" + check, | ||
| "-d", base.resolve(outputDir).toString(), | ||
| "--source-path", src.toString(), | ||
| "x"); | ||
| new OutputChecker(Output.OUT) | ||
| .setExpectFound(true) | ||
| .checkUnique("unknown tag"); | ||
| } | ||
| // DocLint is default | ||
| javadoc("-d", base.resolve("out").toString(), | ||
| "--source-path", src.toString(), | ||
| "x"); | ||
| new OutputChecker(Output.OUT) | ||
| .setExpectFound(true) | ||
| .checkUnique("unknown tag"); | ||
| } | ||
|
|
||
| // Disabled simple tags are treated as known tags, but aren't checked | ||
| // for misuse. Additionally, they don't prevent other tags from being | ||
| // checked. | ||
| @Test | ||
| public void testDisabledSimpleTags(Path base) throws Exception { | ||
| var src = base.resolve("src"); | ||
| tb.writeJavaFiles(src, """ | ||
| package x; | ||
| /** | ||
| * @myDisabledTag foo | ||
| * @myEnabledTag bar | ||
| */ | ||
| public class MyClass extends RuntimeException { } | ||
| """); | ||
| javadoc("-d", base.resolve("out").toString(), | ||
| "-sourcepath", src.toString(), | ||
| "-tag", "myDisabledTag:mX:Disabled Tag", // may appear in methods; disabled | ||
| "-tag", "myEnabledTag:mf:Enabled Tag", // may appear in method and fields; enabled | ||
| "x"); | ||
| checkOutput(Output.OUT, false, "unknown tag"); | ||
| checkOutput(Output.OUT, false, "Tag @myDisabledTag cannot be used in class documentation"); | ||
| checkOutput(Output.OUT, true, "Tag @myEnabledTag cannot be used in class documentation"); | ||
| } | ||
| } |
aecbb1bThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review
Issues