The Javadoc Environment

The IDE includes three dialog boxes for working with Javadoc documentation: Javadoc Index Search, Javadoc Manager, and Auto Comment. The Javadoc executor is also integrated with the Output window and the Source Editor.

Javadoc Index Search

From the Javadoc Index Search dialog box, you can search through Javadoc documentation for information on a specific class, interface, constructor, or method and view that information in a web browser. Open this dialog box from the main window by choosing View and choosing Javadoc Index Search.

Javadoc Manager

The Javadoc Manager lists the Javadoc documentation that you have mounted in the IDE and the Javadoc documentation that you have generated in the IDE from mounted sources. Open the Javadoc Manager from the main window by choosing Tools and choose Javadoc Manager. For each filesystem, you can specify whether the filesystem is visible in the Explorer, which search engine to use, and the root offset. From the Javadoc Manager, you can also mount and unmount Javadoc filesystems.

Auto Comment

Using the Auto Comment Tool, you can check if your source code has valid Javadoc comments and create or edit the comments if necessary. Open the Auto Comment Tool from the Explorer by right-clicking the source file that you want to document and choosing Tools and choose Auto Comment. You can also open the Auto Comment Tool from the contextual menu in the Source Editor.

Output Window

The Output window displays messages from the Javadoc executor.

Source Editor

The Source Editor includes the following items on the contextual menu for working with Javadoc documentation. The documentation displayed is based on the location of the insertion point.

Command Description
Show Javadoc Goes to the Javadoc documentation
Tools and choose Auto Comment Opens the Auto Comment dialog box.
Tools and choose Search Javadoc Opens the Javadoc Index Search dialog box.
Tools and choose Generate Javadoc Generates Javadoc documentation.
Tools and choose Correct Javadoc Available only when there is an invalid Javadoc comment. Opens the Auto Comment dialog box.

In the Source Editor, you can browse Javadoc documentation at the same time you use the code completion feature. By default, a small Javadoc box appears near the code completion box when you use Java code completion. Any available documentation is displayed for the class that is selected in the code completion box.


Legal Notices