Select doclet command line options

This is a feature of JBuilder Professional and Enterprise.

You use this step of the wizard to define what output files are generated and what tags are processed.

Note: This page is also displayed in the Javadoc Properties dialog box.

Standard Options

These options determine what output files are generated.

Generate Hierarchy Tree

Creates the hierarchy tree for all packages, classes and interfaces being documented. For the Standard doclet, generates hierarchy trees on a package-level basis.

Generate Navigation Bar

Creates the standard navigation bar at the top of each HTML output file. This bar includes links to the next and previous package and class, the overview of all packages in the documentation set, the tree file, the index and the help topic.

Generate Index

Generates index entries. Entries are automatically created for each method, field, package, and class.

Separate Index Per Letter

Creates links to entries by letter This option is ignored if you selected the JDK 1.1 doclet type in the Choose a doclet step of the wizard.

Document These Tags

These options determine what Javadoc tags in API source files are processed.

@use

Creates documentation for @use tags. Ignored for the JDK 1.1 doclet type.

@author

Creates documentation for @author tags. This tag adds the author's name to the generated Javadoc. One name or multiple names can be included in a single tag.

@version

Creates documentation for @version tags. This tag adds the code version number to the generated Javadoc. This tag can apply to both a class or element in a class.

@deprecated

Creates documentation for @deprecated tags. This tag adds a comment that this API element will be removed in a future version of the API.

Generate @deprecated List

Generates a list of @deprecated items.

Additional Options

Additional doclet options. For a list of options, go to the Javadoc Tool home page at http://www.java.sun.com/j2se/javadoc/. Browse to information for the JDK 1.1 version (for the JDK 1.1 doclet type) or the JDK 1.3 version (for the Standard type) for your platform.

To increase memory for documentation generation, use the -J option to pass the -Xmx flag directory to the runtime system. (The -Xms flag is optional, as it sets the size of initial memory.) An example of this option is:

-J-Xmx32m

If you know you want to set aside a total of 64 megabytes of memory, you can use both the -Xmx and -Xms flags as follows:

-J-Xmx32m -J-Xms32m