Mounting a Javadoc Filesystem
See Also
Javadoc filesystems have a top-level directory,
usually called api or apidocs. This top-level directory contains
an index.html file, a directory called index-files that contains
multiple index files, or both. The IDE uses these index files to search for
and display Javadoc files.
You must
mount the Javadoc filesystem at the Javadoc top-level directory. For example,
your Javadoc files might be organized in the following structure:
myPackage
src
docs
apidocs
index.html
In this case, you should mount the filesystem at myPackage/docs/apidocs.
If you want to work with the Javadoc files from a JAR or zip file, that JAR
or zip file must be mounted individually as an archive file. Likewise, any Javadoc
files you need from an HTTP connection must be mounted in the IDE.
To mount a Javadoc filesystem:
- From the main window, choose Tools
Javadoc Manager.
- In the Javadoc Manager, mount the filesystem using one of the following command buttons:
- Add Folder. Opens a file chooser in which you mount Javadoc files from a directory.
- Add Archive. Opens a file chooser in which you mount Javadoc files from a JAR or zip file.
- Add HTTP. Opens a dialog box in which you mount Javadoc
files from an HTTP connection.
- Modify the filesystem's properties to your preferred settings:
- Hidden. If True, this filesystem is not visible in the
Filesystems tab of the Explorer.
- Search Engine. Specifies the default Javadoc search engine. You have two choices: the JDK 1.2/1.3 Search Engine, which is the default value,
and the Japanese JDK 1.2/1.3 Search Engine, which enables you to search
internationalized Javadoc documentation.
- Root Offset. Specifies the Javadoc top-level directory. The Javadoc
top-level directory contains the index.html file, a directory called
index-files that contains multiple index files, or both. When your
Javadoc files are in a JAR or zip file, the Javadoc top-level directory is
sometimes buried in the file's hierarchy. In this case, the IDE cannot correctly
search for and display Javadoc files unless the Root Offset property is set
to the Javadoc top-level directory.
Legal Notices