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

Pavel Rappo prappo at openjdk.java.net
Thu Jun 17 17:53:28 UTC 2021


On Thu, 17 Jun 2021 17:36:51 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> Please review a simple fix to add a default implementation for a recent new method on the Reporter interface. (It was an oversight that the default implementation was not provided in the original work.)

Synchronize with the respective CSR.

src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Reporter.java line 97:

> 95:      * The positions should satisfy the relation {@code start <= pos <= end}.
> 96:      *
> 97:      * @implNote

Should be `@implSpec` instead: both here and in the respective CSR.

src/jdk.javadoc/share/classes/jdk/javadoc/doclet/Reporter.java line 98:

> 96:      *
> 97:      * @implNote
> 98:      * This implementation throws {@code UnsupportedOperationException}.

I'd suggest rephrasing this as follows: "This implementation always throws..." both here and in the respective CSR.

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?

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

Changes requested by prappo (Reviewer).

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


More information about the javadoc-dev mailing list