Generating Javadoc Documentation

The Javadoc executor 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 file for which you want to generate documentation.
  2. From the contextual menu, choose Tools and choose Generate Javadoc.

    By default, the documentation is generated in the javadoc directory in your user directory. Messages from the Javadoc executor are displayed in the Output window.

  3. To view the documentation in the web browser, click Yes in the Question dialog box.
Tip If your source code contains the assert keyword, you must configure the Javadoc executor to recognize the keyword. Open the Options window and expand Code Documentation and expand Javadoc Executors and select External Javadoc. Click the value for the External Process property and then click the ellipsis (...) button. In the Property editor, add source 1.4 before the {files} tag.
See also
Specifying an Output Directory for Javadoc Files
Searching Through Javadoc-Generated Documentation
Specifying the Default Javadoc Executor

Legal Notices