This parameter is an analog of
-group
option provided by the Standard Doclet.
It allows you to separates packages on the overview page into whatever groups you specify,
one group per table.
The parameter accepts multiple (list) value. Each value item specifies a single package group.
packagepattern1:packagepattern2:...::groupheading
java.*:javax.*::This is a title
';'
).
Example:
java.awt.*:javax.swing.*::Java GUI API
org.w3c.*::W3C API
java.awt.*:javax.swing.*::Java GUI API;org.w3c.*::W3C API
-p:gen.overview.packages.groups "java.awt.*:javax.swing.*::Java GUI API;org.w3c.*::W3C API"
The same can be also specified with two -p
options:
-p:gen.overview.packages.groups "java.awt.*:javax.swing.*::Java GUI API"
-p:gen.overview.packages.groups "org.w3c.*::W3C API"
-p
option adds a separate value item to
the 'gen.overview.packages.groups'
parameter.
Using Escapes
Each character that serves as a value item separator can be equally used within the value item if escaped with a backslash. If a backslash is not consumed by an escape it will be remained in the text as is. To make sure that a backslash is not part of some escape, you may add another backslash.
For example, a package group with the title:
The API to process ';' and '\' in text
textmill.semicolon.*:textmill.slash.*::The API to process '\;' and '\\' in text
If the all groups do not include all documented packages, any leftover packages appear in a separate group with the heading "Other Packages", which is printed the last.
-group
options found on the Javadoc command line. Each -group
option
is converted to a single value item of this parameter.
So, you can use Standard Doclet's
-group
options instead of specifying this parameter directly.
${include ../refs/standard_doclet_options.htm}