RFR: JDK-8275786: New javadoc option to add script files to generated documentation [v2]

Hannes Wallnöfer hannesw at openjdk.java.net
Wed Nov 10 15:46:09 UTC 2021


On Mon, 8 Nov 2021 18:07:36 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/markup/Head.java line 63:
>> 
>>> 61:     private DocPath mainStylesheet;
>>> 62:     private List<DocPath> additionalStylesheets = Collections.emptyList();
>>> 63:     private List<DocPath> additionalScripts = Collections.emptyList();;
>> 
>> Suggest moving this down a few lines, after `mainBodyScript` and `scripts`.
>
> While I realize the maybe-useful similarity between `additionalStylesheets` and `additionalScripts`, the similarity between `scripts` and `additionalScripts` leaves me asking, "why both?". I'm  not sure I would go as far as a systemic rename of `additionalScripts` to `userScripts`, but maybe a comment on the declaration would be helpful to future readers.

Moved declaration down and added a comment.

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

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


More information about the javadoc-dev mailing list