|
Parameter/Grouping
|
Description
|
|
Window Title
|
Parameter name: windowTitle
Specifies the browser window title for the documentation.
This is similar to
-windowtitle
option provided by Javadoc
Standard Doclet.
In addition, if the selected output format supports pagination (RTF),
the same text will appear on the page footers.
|
|
Documentation Title
|
Parameter name: docTitle
Specifies the title to be placed at the the top of the documentation overview.
|
|
Include
|
|
|
deprecated API
|
Parameter name: include.deprecated
Controls whether to generate documentation for any deprecated API.
|
|
Details Of
|
This group of parameters controls how much details are included
in the generated documentation. This may be important for printing,
since the documentation with all details may occur too big to be printable.
|
|
overview
|
Parameter name: include.details.overview
Specifies whether to include the overview summary for the whole documentation.
|
|
packages
|
Parameter name: include.details.packages
Specifies whether to include the details of packages.
If false (unchecked), only classes separately
specified on the Javadoc command line will be documented.
|
|
classes
|
Parameter name: include.details.classes
Specifies whether to include details of classes.
If false (unchecked), only overview for each package
will be generated without the detailed documentation for the
contained classes.
|
|
inner classes
|
Parameter name: include.details.innerClasses
Specifies whether inner classes should be included into the generation scope.
If true (checked), the inner classes contained
within those already being documented will also be fully documented.
If false, only summaries of the inner classes will be generated.
|
|
members
|
Parameter name: include.details.members
Specifies whether to include details of class members (i.e. methods and fields).
If false (unchecked), only overview for each class will be generated
without the details for the class' members.
|
|
initial values
|
Parameter name: include.details.initialValues
Specify whether the initial values of fields should be shown in the documentation.
|
|
Tags
|
This group of parameters controls whether to include in the generated
docs the sections associated with some tags.
|
|
@version
|
Parameter name: include.tag.version
Include the @version text in the generated docs.
|
|
@author
|
Parameter name: include.tag.author
Include the @author text in the generated docs.
|
|
Custom tags
|
Parameter name: include.tag.custom
This parameter duplicates the functionality of the
-tag
option supported by the
Standard Doclet.
It allows you to include in the generated output the documentation of your custom tags,
specify the tag headings as well as their ordering. You will be able also to redefine
the headings and ordering of the standard tags (such as @param, @see, @author etc).
This parameter accepts multiple (list) value. Each value item specifies how a single tag should be documented.
Specifying Single Tag
Documenting of a single tag is specified with the following expression:
tagname:Xaoptcmf:taghead
The tagname is the name of the tag for which this setting applies.
The taghead is the heading for the tag documentation.
Omitting taghead causes tagname to be used as the heading
(unless this is a standard tag). If the tag has no text (specified in the Java comment),
only the heading will appear in the generated output.
The Xaoptcmf part determines the locations in the source code where the tag
is to be processed/documented. Each letter specify possible tag locations according to this table:
| Letter |
Meaning / Location |
X |
Rather than including the tag, this letter indicates that the tag should be ignored
in the specified locations. For example, specifying
see:X
will suppress documenting of all @see tags. However,
see:Xf
suppresses @see tags only for fields.
|
a |
all locations |
o |
project overview |
p |
packages overviews |
t |
types (that is classes and interfaces) |
c |
constructors |
m |
methods |
f |
fields |
Examples:
The following parameter value item:
threadsafe:a:Can be called safely from multiple threads
specifies a custom @threadsafe tag to be documented anywhere it is used with the heading message:
Can be called safely from multiple threads
The following value item specifies that @todo tag should be processed
only with constructors, methods and fields:
todo:cmf:To Do:
Notice the last colon (:) above is not a separator, but is part of the heading text (as shown below).
You would use either tag option for source code that contains the tag @todo, such as:
@todo The documentation for this method needs work.
This line would produce output something like:
To Do:
The documentation for this method needs work.
Use of Colon in Tag Name
A colon can be used in a tag name if it is escaped with a backslash. For this doc comment:
/**
* @ejb:bean
*/
use the following setting of the parameter value:
ejb\:bean:a:EJB Bean:
Specifying Multiple Tags
Documenting of different tags should be specified in different items of the whole parameter value.
Each value item should define how to document a single tag as described above.
The items must be separated with one of the allowed item separator characters
(newline or ';').
Example:
ejb\:bean:a:EJB Bean:
todo:cmf:To Do:
or the same as a single line:
ejb\:bean:a:EJB Bean:;todo:cmf:To Do:
The last form can be used to specify both tags on the Javadoc command line:
-p:include.tag.custom "ejb\:bean:a:EJB Bean:;todo:cmf:To Do:"
(Note: Because the full parameter value here contains spaces, it is enclosed in quotes
in order to make it treated as a single command-line argument.)
The same can be also specified with two -p options:
-p:include.tag.custom "ejb\:bean:a:EJB Bean:"
-p:include.tag.custom "todo:cmf:To Do:"
Each -p option adds a separate value item to 'include.tag.custom' parameter.
Tag Ordering
The tags will appear in the output documentation in the same order as they are specified
in the value items of this parameter. For instance, in the example above, the documentation
of '@ejb:bean' tag will be followed by the documentation of '@todo' tag.
Using this parameter, you can also redefine the ordering of the standard tags, for example:
version;todo:cmf:To Do:;see
This setting says that @version tag should be documented before the custom @todo tag
followed by the documentation of @see tags.
Any other standard tags will be documented as usual in a certain some predefined order before
the tags specified in this parameter.
Using Escapes
Each character that serves as a value item separator can be equally used within the value items
if escaped with a backslash. For example, documenting of the tag:
@my;odd;tag
can be specified like this:
my\;odd\;tag:a:My odd tag:
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.
A sequence of two backslashes ("\\") is an escape by itself, which represents a single backslash.
This is important because backslashes may be used also in a secondary system of escapes
(e.g. to escape ':' within the tag name).
For example, a string like this:
my\;odd\;tag:a:\My Odd Title:\\;ejb\:bean:a:EJB Bean:
will be initially processed and broken into two value items:
my;odd;tag:a:\My Odd Title\
ejb\:bean:a:EJB Bean:
then, processed further to document all '@my;odd;tag' tags with "\My Odd Title\" title
and all '@ejb:bean' tags with "EJB Bean:" title.
|
|
Exclude
|
Specify what should be entirely excluded from the generation scope.
|
|
By Tags
|
This group of parameters allows you to exclude from the generated documentation classes,
fields and methods with specified tags (custom or not).
|
|
classes & members
|
Parameter name: exclude.byTags.all
Specify tags by which both classes and class members
(i.e. fields, constructors and methods) are completely
excluded from the generated documentation.
A class is excluded when at least one of the conditions is met:
- The class has one of the specified tags.
- This is an inner class and one of its enclosing classes has one of the specified tags.
A class member is excluded according to one of the conditions:
- The member has one of the specified tags.
- The member's class has one of the specified tags.
- The member's class is an inner class and one of its enclosing classes has one of the specified tags.
Therefore, when a class has one of the tags specified in this parameter, neither that class nor anything defined in it (i.e. members and inner classes) will ever appear in the documentation.
The multiple exclude-tag names must be separated with new lines ('\n'), semicolons (';') or colons (':').
For example:
@exclude
@omit
|
|
classes
|
Parameter name: exclude.byTags.classes
This parameter allows you to hide completely from the generated documentation some
intermediate classes of your internal implementation (that for some reasons need to be public),
however, preserve documenting of some fields and methods (defined within those classes)
which are supposed to be part of an open API.
This may be particularly helpful when you will need next time to change your implementation
while keeping intact what you have declared in your open API.
The tags specified in this parameter are treated as the following.
A class will be never mentioned in the documentation when at least one of the conditions is met:
- The class has one of the specified tags.
- This is an inner class and one of its enclosing classes has one of the specified tags.
Each inheritable member of the excluded class that otherwise (without that parameter) would be documented will appear in every direct descendant of that class being documented as if that member has been defined directly there.
Overall effect should be that the generated documentation will look as if the excluded classes
themselves did never exist at all, however, everything else is in place and correct.
The multiple exclude-tag names must be separated with new lines ('\n'), semicolons (';') or colons (':').
For example:
@exclude
@omit
|
|
members
|
Parameter name: exclude.byTags.members
Specify tags by which only class members (i.e. fields, constructors and methods)
are selectively excluded from the generated documentation.
A class member, which otherwise (without this parameter) would be documented,
is excluded when it has at least one of the specified tags.
The multiple exclude-tag names must be separated with new lines ('\n'), semicolons (';') or colons (':').
For example:
@exclude
@omit
|
|
By Annotations
|
This group of parameters provides an alternative way of excluding classes and class members
from the generated documentation.
|
|
|
As you know, one of the new language features introduced in Java 5 is “annotations”.
Annotations are essentially similar to tags. However, unlike tags, they are specified not within
Java comments, but directly in Java code. That is, annotations are processed by the Java compiler
itself and can be retained in the compiled binary classes (which is impossible with tags).
So, similar to tags you can mark some of the classes and members with annotations and, then,
filter them out by those annotations from the generated documentation.
But, why would you need to use annotations? Why are tags not enough?
Let's suppose, you have a library of some core Java classes for internal use.
That library is quite a separate thing. So, you may use it in different projects
(or different people are using it).
Therefore, you maintain that library in a precompiled binary form as a jar-file.
Now, you are developing a project, in which you use that internal library.
You want to publish certain classes of that project as an open API to your system.
But some of those classes you want to publish are inherited from the classes of your
internal library (or implement interfaces from it).
The Java API documentation generated by Javadoc would mention those internal classes
as superclasses (implemented interfaces) of your API.
But you do not want them to be visible in the published documentation (they are internal after all)!
How can you do that?
Marking your internal classes with tags to be excluded by them will not work,
because your tags will not get into the compiled jar-file.
Here is where annotations can help! Let's see how you can do it.
First, you need to define your annotation type like the following (all names are for example):
package myprojects.core.util;
public @interface Internal {
}
These lines should be saved as 'Internal.java' file located in
'myprojects/core/util' package.
Note, as with any Java class, the defined annotation type has a fully qualified name,
which will be the string: 'myprojects.core.util.Internal'.
Only the fully qualified name can be used to find annotations of a given type.
Now, you can use this annotation type to mark your internal classes. Here is how:
package myprojects.core.classes;
...
import myprojects.core.util.Internal;
@Internal
public class MyIterator {
...
}
After that, you can exclude all classes marked with that annotation from the generated
documentation by specifying the annotation type qualified name
'myprojects.core.util.Internal' in the
exclude.byAnns.classes parameter.
This will equally work both with the classes defined in the Java sources and the binary
classes found on the Javadoc classpath!
|
|
classes & members
|
Parameter name: exclude.byAnns.all
Specify annotation types by which both classes and class members
(i.e. fields, constructors and methods) are completely excluded
from the generated documentation.
A class is excluded when at least one of the conditions is met:
- The class has an annotation of one of the specified types.
- This is an inner class and one of its enclosing classes has an annotation of one of the specified types.
A class member is excluded according to one of the conditions:
- The member has an annotation of one of the specified types.
- The member's class has an annotation of one of the specified types.
- The member's class is an inner class and one of its enclosing classes has an annotation of one of the specified types.
Therefore, when a class has one of the annotations specified in this parameter, neither that class nor anything defined in it (i.e. members and inner classes) will ever appear in the documentation.
Each annotation type must be specified with its fully qualified name
(e.g. java.lang.Deprecated).
Multiple annotation type names must be separated with new lines ('\n'), semicolons (';') or colons (':').
For example:
my.core.util.Internal
my.project.api.Exclude
For more details about using annotations, see description of the
Exclude | By Annotations parameter group.
|
|
classes
|
Parameter name: exclude.byAnns.classes
This parameter allows you to hide completely from the generated documentation some intermediate
classes of your internal implementation (that for some reasons need to be public), however,
to preserve documenting of some fields and methods (defined within those classes)
which are supposed to be part of an open API.
This may be particularly helpful when you will need next time to change your implementation
while keeping intact what you have declared in your open API.
The annotation types specified in this parameter are treated as the following.
A class will be never mentioned in the documentation when at least one of the conditions is met:
- The class has an annotation of one of the specified types.
- This is an inner class and one of its enclosing classes has an annotation of one of the specified types.
Each inheritable member of the excluded class that otherwise (without that parameter)
would be documented will appear in every direct descendant of that class being documented
as if that member has been defined directly there.
Overall effect should be that the generated documentation will look as if the excluded classes
themselves did never exist at all, however, everything else is in place and correct.
Each annotation type must be specified with its fully qualified name
(e.g. java.lang.Deprecated).
Multiple annotation type names must be separated with new lines ('\n'), semicolons (';') or colons (':').
For example:
my.core.util.Internal
my.project.api.Exclude
For more details about using annotations, see description of the
Exclude | By Annotations parameter group.
|
|
members
|
Parameter name: exclude.byAnns.members
Specify annotation types by which only class members (i.e. fields, constructors and methods)
are selectively excluded from the generated documentation.
A class member, which otherwise (without this parameter) would be documented,
is excluded when it has an annotation of one of the specified types.
Each annotation type must be specified with its fully qualified name
(e.g. java.lang.Deprecated).
Multiple annotation type names must be separated with new lines ('\n'), semicolons (';') or colons (':').
For example:
my.core.util.Internal
my.project.api.Exclude
For more details about using annotations, see description of the
Exclude | By Annotations parameter group.
|
|
Omit
|
This group of parameters controls which information should not appear in the generated documentation.
|
|
Package qualifiers started with
|
Parameter name: omit.packageQualifiers.for
Specify the packages whose qualifying names should be omitted from ahead of class names
in parameters, types, referenced classes (like exception lists, implemented interfaces, etc.),
@see tags and {@link} tags in comments.
The packages to omit are specified as the list of package name prefixes delimited with new
lines ('\n'), semicolons (';') or colons (':').
For example:
java.lang.
javax.swing.
When a particular fully-qualified name is decided whether
to be shortened, the answer will be yes when the full name
starts with one of the specified prefixes.
|
|
All package qualifiers
|
Parameter name: omit.packageQualifiers.all
If selected, all qualifying package names will be omitted
from ahead of class names in parameters, types, referenced
classes (like exception lists, implemented interfaces, etc.),
@see tags and {@link} tags in comments.
|
|
Inherited member lists for packages
|
Parameter name: omit.inheritedMemberLists.for
Suppress generation of lists of the inner classes, fields or methods inherited
from those classes/interfaces, which belong to the packages specified with this parameter.
This parameter may be especially useful to suppress long lists of the class members inherited
from the standard Java API classes and, in such a way, to considerably reduce the output documentation.
The packages, whose classes/inerfaces should not appear in the "inherited from ..." lists,
are specified as the list of the package name prefixes delimited with new lines
('\n'), semicolons (';') or colons (':').
For example, the following will exclude lists of the members inherited from most of the standard Java API classes:
java.lang.javax.swing.
|
|
All inherited member lists
|
Parameter name: omit.inheritedMemberLists.all
If selected, no lists of inherited inner classes, fields or methods will be generated at all.
|
|
Formatting
|
This group of parameters controls some formatting features
of the output documentation specifically generated by this template.
|
|
Start package from new page
|
Parameter name: fmt.page.breakBefore.package
If true (checked), each package documentation will be started from a new page.
|
|
Start class from new page
|
Parameter name: fmt.page.breakBefore.class
If true (checked), each class documentation will be started from a new page.
|
