RFR: 8273001: Improve the doclet.usage.tagletpath option description [v3]
Pavel Rappo
prappo at openjdk.java.net
Mon Jan 10 12:23:12 UTC 2022
> 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).
Pavel Rappo has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains three additional commits since the last revision:
- Merge branch 'openjdk:master' into 8273001
- Rephrase taglet.description as per feedback
Also indents the value for doclet.usage.tagletpath.parameters.
- Initial commit
-------------
Changes:
- all: https://git.openjdk.java.net/jdk/pull/6745/files
- new: https://git.openjdk.java.net/jdk/pull/6745/files/8465fd3d..a031dee1
Webrevs:
- full: https://webrevs.openjdk.java.net/?repo=jdk&pr=6745&range=02
- incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=6745&range=01-02
Stats: 40060 lines in 1122 files changed: 28957 ins; 6210 del; 4893 mod
Patch: https://git.openjdk.java.net/jdk/pull/6745.diff
Fetch: git fetch https://git.openjdk.java.net/jdk pull/6745/head:pull/6745
PR: https://git.openjdk.java.net/jdk/pull/6745
More information about the javadoc-dev
mailing list