Mounting a Javadoc Filesystem

To work with Javadoc filesystems that were created outside of the IDE, you must mount them in the IDE. 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 which contains multiple index files, or both. The IDE uses these index files to search for and display Javadoc files.

For the IDE to be able to find and display Javadoc files correctly, 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 directory:

  1. In the Explorer, click the Javadoc tab.
  2. In the Javadoc tab, right-click the Javadoc root node and choose Add Local Directory.
  3. In the Mount Directory dialog box, select the Javadoc top-level directory.
  4. Click Mount.

To mount a JAR or zip file:

  1. In the Explorer, click the Javadoc tab.
  2. In the Javadoc tab, right-click the Javadoc root node and choose Add Archive (JAR, Zip).
  3. In the Mount JAR Archive dialog box, select the JAR or zip file that contains the Javadoc documentation.
  4. Click Mount.
Tip If the Javadoc top-level directory is not located in the top level of the JAR or zip hierarchy, the IDE displays a warning that it could not find any Javadoc files. Click OK to mount the filesystem, then right-click the Javadoc filesystem root node and choose Properties. In the Expert tab, set the Root Offset property to the Javadoc top-level directory.

To mount an HTTP filesystem:

  1. In the Explorer, click the Javadoc tab.
  2. In the Javadoc tab, right-click the Javadoc node and choose Add HTTP filesystem.
  3. In the Choose URL dialog box, type the URL that contains the Javadoc documentation.
  4. Click OK.

    The URL is added to the Javadoc tab.

See also
Mounting a Filesystem
Configuring a Javadoc Filesystem
Unmounting a Javadoc Filesystem

Legal Notices