Withdrawn: 8273001: Improve the doclet.usage.tagletpath option description
duke
duke at openjdk.java.net
Mon Feb 7 16:30:08 UTC 2022
On Tue, 7 Dec 2021 14:38:28 GMT, Pavel Rappo <prappo at openjdk.org> wrote:
> Please review this PR to clarify javadoc help output. The net effect of this change can be seen when comparing the relevant excerpts from before and after output.
>
> Before:
>
> ...
> --snippet-path <path>
> The path for external snippets
> -sourcetab <tab length>
> Specify the number of spaces each tab takes up in the source
> -splitindex Split index into one file per letter
> -tag <name>:<locations>:<header>
> Specify single argument custom tags
> -taglet The fully qualified name of Taglet to register
> -tagletpath The path to Taglets
> ...
>
>
> After:
>
> ...
> --snippet-path <path>
> The path to external snippets
> -sourcetab <tab length>
> Specify the number of spaces each tab takes up in the source
> -splitindex Split index into one file per letter
> -tag <name>:<locations>:<header>
> Specify single argument custom tags
> -taglet The fully qualified name of taglet to register
> -tagletpath <path>
> The path to custom taglets
> ...
>
>
> I'm not a grammarian, but:
>
> * "To" seems more appropriate than "for" in this context.
> * There's no reason to use title-cased "Taglet(s)". At least there's no more reason for this than there is for "Doclet(s)", which is consistently spelled as "doclet(s)" (except for where it starts a sentence).
This pull request has been closed without being integrated.
-------------
PR: https://git.openjdk.java.net/jdk/pull/6745
More information about the javadoc-dev
mailing list