Javadoc wizard

This is a feature of JBuilder Professional and Enterprise.

The Javadoc wizard creates Javadoc formatted output files from class and method level comments blocks in your API source files. The wizard provides options for determining the format of the output, what packages are documented, and what output for those packages is generated. Each time you build your project, Javadoc can automatically be created for the packages specified in the wizard.

The wizard creates a documentation node in the project pane. You can reset properties for the node by right-clicking it and selecting Properties. You can also generate Javadoc at any time by selecting the node and choosing Make. To look at your Javadoc once it's been built, use the Doc tab in the AppBrowser when a package node or Java file is open. You can also expand the documentation node and open the index HTML file.

To open the Javadoc wizard, choose File|New, select the New tab of the object gallery, then double-click the Javadoc wizard icon. You can also open the wizard from the Wizards menu (Wizards|Javadoc).

Important: Some generated index and summary files are always output to the root of the output directory. In those cases, only the file for the last Javadoc build will be present.



Choose a doclet

The first step of the wizard allows you to choose how the final Javadoc output will be displayed. Output is controlled by a doclet, a Java class that specifies the contents and format of the HTML output files.

Doclet Name

A drop-down list of the types of doclets you can choose from:

Description

A brief description of the doclet selected in the Doclet Name field.