Preparing the Explorer's Javadoc tab
Before you can do Javadoc searches within the IDE, directories (or JAR or ZIP files) with standard API documentation need to be in the search path.
There should be two directories already mounted under the Javadoc tab in the Explorer:
- The Java API
docs
directory (if it is installed under the Java 2 installation directory). It will appear there with a name such as/usr/jdk1.2.2/docs/api
.- The
Javadoc
directory (which can be found in the root of the IDE's installation directory).Note: By default, Javadoc search directories are set to hidden, meaning they will not be displayed under the Filesystems tab in the Explorer. If you would like to have a Javadoc directory displayed under Filesystems, choose Project | Settings... from the main menu, expand the
Filesystems Settings
node in the Project Settings window, select the Javadoc directory's node, and set itsHidden
property toFalse
.If neither directory is present or you would like to add a new directory with Javadoc documentation, you can add them by following this procedure.
To add a Javadoc documentation directory to the Javadoc tab in the Explorer:
- In the Explorer, select the Javadoc tab, right-click on the
Javadoc
node, and choose Add Directory... from the contextual menu. (If you are adding a JAR or ZIP file with Javadoc documentation, choose Add JAR... for JAR or ZIP files).![]()
- In the Mount Directory dialog box (or Mount JAR Archive dialog box when mounting a JAR or ZIP archive) that appears, choose the directory with the Javadoc documentation.
When selecting the Javadoc documentation directory, you should look at all original documentation distributed with the SDK and be sure that it has an
index-files
directory orindex-all.html
file in the top level or the second level of its hierarchy.![]()
Contents | Prev | Next | Index |