The Javadoc executors use the default standard
to determine
the content and format of the documentation output. The
standard doclet generates API documentation in HTML format.
You can perform the following actions on the standard doclet:
Modify the properties of the standard doclet
Create a new instance of the standard doclet and customize its properties
To modify the properties of the standard doclet:.
From the main window, choose Tools Options.
In the Options window, expand Code Documentation Doclets.
Select Standard Doclet and modify its values to your preferred settings.
Author.
If True, includes the @author text in the generated documentation.
Bottom.
Specifies text that appears at the bottom of each HTML file.
The text is placed below the navigation bar. The text may contain HTML tags. White space must be enclosed in quotation marks, and quotation marks within the text must be escaped.
Charset.
Specifies the HTML character set for the generated documentation (for example, iso-8859-1).
Destination.
Specifies the directory where the generated files are saved. By default, this directory is the javadoc directory in
your IDE user directory.
Doc Title.
Specifies the title that appears centered at the top of the overview summary file, directly below the navigation bar. The text may contain HTML tags. White space must be enclosed in quotation marks, and quotation marks within the text must be escaped.
Footer.
Specifies the text that appears at the bottom of each HTML file.
The text is placed to the right of the navigation bar. The text may contain HTML tags. White space must be enclosed in quotation marks, and quotation marks within the text must be escaped.
Group.
Separates the packages on the overview page into the groups that
you designate. The groups are placed on the page in the order that you specify
them. Packages are alphabetized
within the group.
Header.
Specifies the text that appears at the top of each file. The text is placed
to the right of the navigation bar. The text may contain HTML tags. White space must be enclosed in quotation marks, and quotation marks within the
text must be escaped.
Help File.
Specifies an alternate help file for the HELP link in the navigation bars at the top and bottom of each page. By default, this file is help-doc.html.
Link.
Specifies the URL for external Javadoc documentation to
which you want to link. This property enables you to link to classes
referenced by your code.
Link Offline.
Use this option instead of Link if, at the time you run the Javadoc
executor, the external document's package-list file does not exist at the root location of the external documentation (is "offline") but exists at a different location (typically local).
No Deprecated.
If True, prevents generation of any deprecated API in the documentation.
No Deprecated List.
If True, prevents generation of the file deprecated-list.html,
which contains the list of deprecated APIs,
and the link in the navigation bar to that page.
(The Javadoc executor continues to generate the deprecated API
throughout the rest of the document.)
No Help.
If True, omits the HELP link in the navigation bars at the top and bottom of each page.
No Index.
If True, omits the index from the generated documentation.
No Navbar.
If True, does not include the navigation bar, header, and footer
in the generated documentation. This property is useful when you are converting the files to PostScript or PDF for print.
No Tree.
If True, does not include the class or interface hierarchy in the generated documentation.
Split Index.
If True, separates the index file into multiple files, one file per letter, plus a file for
entries beginning with non-alphabetical characters.
Style Sheet File.
Specifies the path to
the style sheet, a set of stylistic rules that describe how to
present the HTML pages, including size, color, spacing of text.
If a file is not specified, the file stylesheet.css is used.
Use.
If True, includes a "Use" page for each documented class and package.
This page describes the packages, classes, methods, constructors and fields
that use an API of the given class
or package.
Version.
If True, includes the @version text in the generated documentation.
Window Title.
Specifies the text to include in the HTML <title> tag.
This text appears in the window title and in any browser bookmarks created for the page. The title text may not include HTML tags
and any quotation marks within the text must be escaped.
To create a custom doclet:.
In the Options window, expand the Code Documentation node.
Right-click the Doclets node and choose New Standard Doclet.
In the wizard, type a name for the doclet and click Finish.
A node for the doclet is added under the Doclets node in the Options window.
Select the new doclet and modify its values to your preferred settings.
For more information on the properties of the standard doclet,
see the Sun Microsystems web page at
http://java.sun.com/j2se/1.4/docs/tooldocs/solaris/javadoc.html.