RFR: JDK-8286338: suppress warnings about bad @author tags when author info is not generated.

Jonathan Gibbons jjg at openjdk.java.net
Thu May 12 23:15:47 UTC 2022


On Fri, 6 May 2022 22:25:30 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

> What's that `-XDdummy=dummy` you use in tests?

It's a no-op placeholder. JavaDoc does not allow empty arguments, and the alternative is dynamically build a list with a conditional component.  `-XD` is a "hidden" option to inject values in the compiler options map, so `-XDdummy=dummy` just injects a dummy value there.

> 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?

Yes, this is a holdover from the bad old days before `JavadocTester`, when tests were set up using fixed arrays like these. Frankly, I'm surprised these two empty arrays escaped notice for so long.

> test/langtools/jdk/javadoc/doclet/testVersionTag/TestVersionTag.java line 57:
> 
>> 55:                   """
>> 56:                       package pkg;
>> 57:                       /** Introduction.
> 
> Cleanup?

yes

-------------

PR: https://git.openjdk.java.net/jdk/pull/8583


More information about the javadoc-dev mailing list