Modifying Doclet Properties

In the IDE, the Javadoc modules uses the default standard to determine the content and format of its output. The standard doclet generates API documentation in HTML format.

To modify the properties of the standard doclet:

  1. From the main window, choose Project Settings.
  2. In the Project Settings window, expand the Doclets node.
  3. Select Standard Doclet and modify its values to your preferred settings.
    Author 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 user directory.
    Doc Title Specifies the title that is 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 you specify them in. 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 existing Javadoc documentation to which you want to link. This property enables you to link to classes referenced by your code.
    No Deprecated If True, does not generate any deprecated API in the documentation.
    No Deprecated List If True, does not generate 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, does not include the HELP link in the navigation bars at the top and bottom of each page.
    No Index If True, does not include the index in 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 (for example, 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, right-click the Doclets node and choose New Standard Doclet Service. A node for the doclet is added to the Project Settings window. Select the node and modify its properties to your preferred values.

For more information on the properties of the standard doclet, see the Sun Microsystems web page at

http://java.sun.com/j2se/1.3/docs/tooldocs/solaris/javadoc.html.

See also
Specifying the Default Javadoc Search Engine
Specifying the Default Javadoc Executor

Legal Notices