RFR: JDK-8286338: suppress warnings about bad @author tags when author info is not generated.
Pavel Rappo
prappo at openjdk.java.net
Fri May 6 22:28:56 UTC 2022
On Fri, 6 May 2022 22:06:17 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:
> Please review a simple small change to `TagletManager`, to not report warnings about bad use of tags (such as `@author` and `@version`) when command-line options have not been given to enable the use of the tags in the output (i.e. the `-author` and the dreadfully-named `-version` option.)
>
> The change is more pragmatic than anything else. There are lots of "bad" uses of `@author` in JDK API documentation, on methods. The alternative would be to permit the tag anywhere, but that would be both a spec change and work to implement the change that we're not really interest in, since the tag is now somewhat deprecated.
>
> Two existing tests are updated, to test the handling of "bad" tags, with and without the enabling option.
>
> Another test has some very (very) old unused lines deleted. If today was Thursday, I'd call it Throwback Thursday. These lines predate the `JavadocTester` conversion.
What's that `-XDdummy=dummy` you use in tests?
test/langtools/jdk/javadoc/doclet/testSimpleTagInherit/TestSimpleTagInherit.java line 38:
> 36: public class TestSimpleTagInherit extends JavadocTester {
> 37:
> 38: //Javadoc arguments.
This seems like an unrelated change; is it cleanup?
test/langtools/jdk/javadoc/doclet/testVersionTag/TestVersionTag.java line 57:
> 55: """
> 56: package pkg;
> 57: /** Introduction.
Cleanup?
-------------
PR: https://git.openjdk.java.net/jdk/pull/8583
More information about the javadoc-dev
mailing list