RFR: 8322036: Improve help output from the javadoc tool

Pavel Rappo prappo at openjdk.org
Mon Aug 26 10:35:05 UTC 2024


On Tue, 20 Aug 2024 14:46:07 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> > Outside this PR diff, do we need to lowercase this ["Standard Doclet"](https://github.com/openjdk/jdk/blob/d0a265039a36292d87b249af0e8977982e5acc7b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties#L26-L25) similarly to how it is done in JDK-8290702, whose updates this PR carries over to javadoc help output?
> 
> I still have mixed thoughts on this. The name of the doclet has always been "Standard Doclet": that is a proper noun and should be capitalized. The lower case form, "standard doclet" is just a description.
> 
> That being said, I agree we should be consistent.

Jon, is it possible to figure it out once and for all? It's time consuming to discuss it anew every time a new case is found. Are you saying that these two cases, which are currently present in the mainline, are okay because the meaning is slightly different?

    ...
    doclet.build_version=Standard Doclet version {0}
    ...
    doclet.help.footnote=\
    This help file applies to API documentation generated by the standard doclet.

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

PR Comment: https://git.openjdk.org/jdk/pull/20618#issuecomment-2309883464


More information about the javadoc-dev mailing list