Generating Documentation With Javadoc

Javadoc parses the declarations and documentation comments in specified source files and produces a set of HTML pages that describe the classes, inner classes, interfaces, constructors, methods, and fields.

To generate documentation:

  1. In the Filesystems tab of the Explorer, right-click the package or source file for which you want to generate documentation.

  2. From the contextual menu, choose Tools Generate Javadoc.

  3. In the Javadoc Destination Directory dialog box, enter the name of the directory where you want to store the documentation.

    By default, the documentation is stored in the javadoc directory in your installation directory.

  4. Click OK.

    The IDE displays messages from Javadoc in an Output window. An alert box asks if you want to view the Javadoc-generated documentation in the web browser.

  5. Click Yes.
Searching Through Javadoc-Generated Documentation
Customizing the Output of Javadoc
See also

Legal Notices