RFR: 8322036: Improve help output from the javadoc tool [v3]

[Pavel Rappo]

On Thu, 22 Aug 2024 18:11:16 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 u...
>
> Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision:
> 
>   - replace backticks with single quotes
>   - drop use of underscores
>   - capitalize first letter for "doclet"

src/jdk.javadoc/share/classes/jdk/javadoc/internal/tool/resources/javadoc.properties line 280:

> 278: These options are non-standard and subject to change without notice.
> 279: 
> 280: main.doclet.usage.header=\nProvided by the {0} Doclet:

I'm unsure about this one: `{0}` does not necessarily expand to `Standard`.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/20618#discussion_r1731049669