Javadoc Filesystem
The Javadoc tab of the Explorer displays the Javadoc documentation that
is mounted in the IDE or that was generated in the IDE
from mounted sources. By default, two Javadoc filesystems are mounted: the ant-api.zip filesystem, which
includes the Ant documentation, and the javadoc directory in
your installation directory. The Javadoc executor generates documentation in this directory when no other directory is specified.
Right-clicking the Javadoc root node (
) opens a menu with items for mounting new Javadoc filesystem in the IDE. You can mount Javadoc documentation from the following sources:
- A directory that was created outside the IDE
- A JAR file or a zip file
- An HTTP filesystem
You can configure each mounted filesystem separately. To view the property sheet for a filesystem, right-click the root node of the filesystem and choose Properties. The Properties tab includes the following properties.
- Hidden.If True, does not display the mounted filesystem in the Javadoc tab.
- Read Only. If True, this filesystem cannot be modified.
- Root Directory. For directories only. Specifies the root directory of this filesystem. See Mounting a Filesystem for more information.
- Archive File. For JAR and zip files only. Specifies the JAR or zip file that the filesystem represents.
- URL. For HTTP filesystems only. Specifies the base URL of the Javadoc documentation.
The Expert tab has the following properties:
- Root Offset. Specifies a
folder below the mount point that matches the Javadoc's package root, so
that the IDE correctly understands the package structure of the Javadoc
files. The root offset is important in cases where it is not possible
to mount the Javadoc filesystem at its package root.
- 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.
Legal Notices