RFR: 8322036: Improve help output from the javadoc tool

[Jonathan Gibbons]

On Fri, 16 Aug 2024 15:03:58 GMT, Nizar Benalla <nbenalla at openjdk.org> wrote:

> Could I please get a review for this small clenup? I updated the `--help` command output to match that of `man javadoc`.
> 
> I also noticed that  `--help-extended` was renamed to `--help-extra` at some point but doc-comment was not changed, so I changed it.
> I could create a separate issue for it if needed, just to keep a record of it.
> 
> The new `javadoc --help` output is the following 
> 
> 
> javadoc --help
> Usage:
>     javadoc [options] [packagenames] [sourcefiles] [@files]
> where options include:
>     @<file>       Read options and filenames from file
>     --add-modules <module>(,<module>)*
>                   Root modules to resolve in addition to the initial modules,
>                   or all modules on the module path if <module> is
>                   ALL-MODULE-PATH.
>     -bootclasspath <path>
>                   Override location of platform class files used for non-modular
>                   releases
>     -breakiterator
>                   Compute first sentence with BreakIterator
>     --class-path <path>, -classpath <path>, -cp <path>
>                   Specify where to find user class files
>     -doclet <class>
>                   Generate output via alternate doclet
>     -docletpath <path>
>                   Specify where to find doclet class files
>     --enable-preview
>                   Enable preview language features. To be used in conjunction with
>                   either -source or --release.
>     -encoding <name>
>                   Source file encoding name
>     -exclude <pkglist>
>                   Specify a list of packages to exclude
>     --expand-requires (transitive|all)
>                   Instructs the tool to expand the set of modules to be
>                   documented. By default, only the modules given explicitly on
>                   the command line will be documented. A value of "transitive"
>                   will additionally include all "requires transitive"
>                   dependencies of those modules. A value of "all" will include
>                   all dependencies of those modules.
>     -extdirs <dirlist>
>                   Override location of installed extensions
>     --help, -help, -?, -h
>                   Display command-line options and exit
>     --help-extra, -X
>                   Print a synopsis of nonstandard options and exit
>     -J<flag>      Pass <flag> directly to the runtime system
>     --limit-modules <module>(,<module>)*
>                   Limit the universe of observable modules
>     -locale <name>
>                   Locale to be used, e.g. en_US or en...

> 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.

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

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