[jdk17] RFR: JDK-8268972: Add default impl for recent new Reporter.print method [v2]

Pavel Rappo prappo at openjdk.java.net
Thu Jun 17 18:40:51 UTC 2021


On Thu, 17 Jun 2021 18:06:35 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Reporter.java line 101:
>> 
>>> 99:      * The implementation provided by the {@code javadoc} tool to
>>> 100:      * {@link Doclet#init(Locale, Reporter) initialize} a doclet
>>> 101:      * overrides this implementation.
>> 
>> Overrides how?
>
> ...per the documented spec.   I tried writing `The implementation .... always generates an appropriate diagnostic` but that's not true if an exception is thrown, and writing `The implementation ... does not throw UOE` seems weird.

The difficulty you have with ironing out this wording wrinkle suggests that the behavior of the `Reporter` provided to `Doclet.init` should be described in `Doclet.init` rather than here. The same goes for other default methods of Reporter.

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

PR: https://git.openjdk.java.net/jdk17/pull/92


More information about the javadoc-dev mailing list