RFR: JDK-8280738: Minor cleanup for HtmlStyle

Hannes Wallnöfer hannesw at openjdk.java.net
Thu Jan 27 10:46:35 UTC 2022


On Wed, 26 Jan 2022 18:45:15 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> Please review a simple update to reorder some members of the enum `HtmlStyle`, and to make some minor updates to the comments.
> 
> This is to facilitate automated extraction of information into an upcoming new spec for the output from the standard doclet.

Looks good. The `@apiNote` regarding editor-folds could be improved (missing parenthesis).

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/HtmlStyle.java line 53:

> 51:  * @apiNote
> 52:  * The stylized use of {@code editor-fold} comments and line comments (beginning {@code //}
> 53:  * is to support extracting details of declarations with external tools.  Edit with care!

Missing closing parenthesis

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

Marked as reviewed by hannesw (Reviewer).

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


More information about the javadoc-dev mailing list