8322036: Improve help output from the javadoc tool
Reviewed-by: prappo
This commit is contained in:
parent
1ff9ac7233
commit
2150521650
src/jdk.javadoc/share/classes/jdk/javadoc/internal
@ -478,7 +478,8 @@ doclet.usage.author.description=\
|
||||
Include @author paragraphs
|
||||
|
||||
doclet.usage.docfilessubdirs.description=\
|
||||
Recursively copy doc-file subdirectories
|
||||
Enables deep copying of 'doc-files' directories. Subdirectories and all\n\
|
||||
contents are recursively copied to the destination
|
||||
|
||||
doclet.usage.splitindex.description=\
|
||||
Split index into one file per letter
|
||||
@ -515,7 +516,7 @@ doclet.usage.html5.description=\
|
||||
doclet.usage.footer.parameters=\
|
||||
<html-code>
|
||||
doclet.usage.footer.description=\
|
||||
Include footer text for each page
|
||||
This option is no longer supported and reports a warning
|
||||
|
||||
doclet.usage.top.parameters=\
|
||||
<html-code>
|
||||
@ -553,7 +554,7 @@ doclet.usage.link-platform-properties.description=\
|
||||
doclet.usage.excludedocfilessubdir.parameters=\
|
||||
<name>,<name>,...
|
||||
doclet.usage.excludedocfilessubdir.description=\
|
||||
Exclude any doc-files subdirectories with given name.\n\
|
||||
Exclude any 'doc-files' subdirectories with given name.\n\
|
||||
':' can also be used anywhere in the argument as a separator.
|
||||
|
||||
doclet.usage.group.parameters=\
|
||||
@ -614,7 +615,7 @@ doclet.usage.nooverview.description=\
|
||||
Do not generate overview pages
|
||||
|
||||
doclet.usage.serialwarn.description=\
|
||||
Generate warning about @serial tag
|
||||
Reports compile-time warnings for missing '@serial' tags
|
||||
|
||||
doclet.usage.since.parameters=\
|
||||
<release>(,<release>)*
|
||||
@ -629,7 +630,7 @@ doclet.usage.since-label.description=\
|
||||
doclet.usage.tag.parameters=\
|
||||
<name>:<locations>:<header>
|
||||
doclet.usage.tag.description=\
|
||||
Specify single argument custom tags
|
||||
Specifies a custom tag with a single argument
|
||||
|
||||
doclet.usage.taglet.description=\
|
||||
The fully qualified name of Taglet to register
|
||||
@ -654,7 +655,8 @@ doclet.usage.javafx.description=\
|
||||
doclet.usage.helpfile.parameters=\
|
||||
<file>
|
||||
doclet.usage.helpfile.description=\
|
||||
Include file that help link links to
|
||||
Specifies a file containing the text that will be displayed when the\n\
|
||||
help link in the navigation bar is clicked
|
||||
|
||||
doclet.usage.linksource.description=\
|
||||
Generate source in HTML
|
||||
@ -691,7 +693,8 @@ doclet.usage.override-methods.description=\
|
||||
The default is 'detail'.
|
||||
|
||||
doclet.usage.allow-script-in-comments.description=\
|
||||
Allow JavaScript in options and comments
|
||||
Allow JavaScript in documentation comments, and options\n\
|
||||
whose value is html-code
|
||||
|
||||
doclet.usage.xdocrootparent.parameters=\
|
||||
<url>
|
||||
|
@ -678,7 +678,7 @@ public class ToolOptions {
|
||||
|
||||
/**
|
||||
* Show command-line help for the extended options, as requested by
|
||||
* the {@code --help-extended} option and its aliases.
|
||||
* the {@code --help-extra} option and its aliases.
|
||||
*/
|
||||
void Xusage();
|
||||
|
||||
|
@ -67,7 +67,7 @@ main.opt.private.desc=\
|
||||
main.opt.show.members.arg=\
|
||||
<value>
|
||||
main.opt.show.members.desc=\
|
||||
Specifies which members (fields, methods, etc.) will be\n\
|
||||
Specifies which members (fields, methods, or constructors) will be\n\
|
||||
documented, where value can be one of "public", "protected",\n\
|
||||
"package" or "private". The default is "protected", which will\n\
|
||||
show public and protected members, "public" will show only\n\
|
||||
@ -87,7 +87,7 @@ main.opt.show.types.desc=\
|
||||
main.opt.show.packages.arg=\
|
||||
<value>
|
||||
main.opt.show.packages.desc=\
|
||||
Specifies which module's packages will be documented. Possible\n\
|
||||
Specifies which module packages will be documented. Possible\n\
|
||||
values are "exported" or "all" packages.
|
||||
|
||||
main.opt.show.module.contents.arg=\
|
||||
@ -97,7 +97,7 @@ main.opt.show.module.contents.desc=\
|
||||
declarations. Possible values are "api" or "all".
|
||||
|
||||
main.opt.expand.requires.arg=\
|
||||
<value>
|
||||
(transitive|all)
|
||||
main.opt.expand.requires.desc=\
|
||||
Instructs the tool to expand the set of modules to be\n\
|
||||
documented. By default, only the modules given explicitly on\n\
|
||||
|
Loading…
x
Reference in New Issue
Block a user