Working With Javadoc Documentation

From within the IDE, you can search Javadoc-generated HTML pages for a specific class, interface, constructor, method, or field. You can search the Javadoc-generated documentation from either the Source Editor or the Javadoc Index Search dialog box, which is available from the View menu. The Javadoc tab of the Explorer displays Javadoc documentation that you have mounted in the IDE or that you have generated in the IDE from mounted sources.

If Javadoc documentation doesn't exist for your project, you can add Javadoc comments to your source code and generate the documentation from within the IDE. Each java source node in the Explorer includes a contextual menu with items for creating comments, generating Javadoc documentation, and viewing the documentation. The Javadoc tool uses the default standard and generates the API documentation in HTML format.

To work with Javadoc files that were created outside of the IDE, you must mount them in the IDE. You can mount local directories, JAR and zip files, and and HTTP connections.

You can set options for the Javadoc tool in the Options window. You can specify which Javadoc search engine, executor, and doclet to use and modify their properties. Using the external Javadoc executor is recommended over using the internal Javadoc executor because you are less likely to get an out of memory error. Generating documentation for large amounts of code, such as the JDK, consumes a large amount of memory.

For help working with Javadoc documentation, see:

Searching Through Javadoc-Generated Documentation
Browsing JDK Documentation
Generating Javadoc Documentation
Commenting Java Source Code
Mounting Javadoc Filesystems
Setting Javadoc Options

Legal Notices