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:

  1. From the main window, choose Tools and choose Javadoc Manager.
  2. In the Javadoc Manager, mount the filesystem using one of the following command buttons:
  3. Modify the filesystem's properties to your preferred settings:
See Also
Removing a Javadoc Filesystem
Javadoc Manager

Legal Notices