Skip to content

8328848: Inaccuracy in the documentation of the -group option #25212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

8328848: Inaccuracy in the documentation of the -group option #25212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...doc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -599,7 +599,7 @@ doclet.usage.excludedocfilessubdir.description=\
doclet.usage.group.parameters=\
<name> <g1>,<g2>...
doclet.usage.group.description=\
Group specified elements together in overview page.\n\
Group specified packages or modules together in overview page.\n\
':' can also be used anywhere in the argument as a separator.

doclet.usage.legal-notices.parameters=\
Expand Down
5 changes: 3 additions & 2 deletions src/jdk.javadoc/share/man/javadoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,8 +510,9 @@ The following options are provided by the standard doclet.
<span id="option-footer">`-footer` *html-code*</span>
: This option is no longer supported and reports a warning.

<span id="option-group">`-group` *name* *p1*`,`*p2...*</span>
: Group the specified packages together in the Overview page.
<span id="option-group">`-group` *name* *g1*`,`*g2...*</span>
: Group the specified packages, or modules when documenting modular code,
together in the Overview page.
For historical reasons, `:` can be used as a separator anywhere in the
argument instead of `,`.

Expand Down