Generating Javadoc documentation
You can have documentation for entire classes and packages generated automatically.
To generate Javadoc documentation:
- Select the packages and/or source files for which you would like to create documentation in the Explorer (under the Filesystems tab) or in the Object Browser.
- Right-click on the object's node and choose Tools | Generate Javadoc from the contextual menu. A dialog box will appear asking you to name the directory where you want the Javadoc documentation generated.
Once you enter a directory, another dialog box will appear and ask you whether to open the generated documentation in the internal web browser.
By default, the generated Javadoc documentation will be stored in the directory
javadoc
in the IDE's home directory. Since this is mounted under the Javadoc tab by default, you can later search its contents using the Javadoc Index Search. See Searching in Javadoc directories.
Contents | Prev | Next | Index |