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 that 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 Javadoc filesystem:
The Javadoc Manager lists the Javadoc documentation that you have mounted in the IDE. The Javadoc Manager also lists the Javadoc documentation that you have generated in the IDE from mounted sources.
Once you mount the Javadoc documentation in the IDE, its name is added to the list in the Javadoc Manager.
![]() |
If the Javadoc top-level directory is not located in the top-level of the directory, JAR, or zip hierarchy, the IDE displays a warning that it could not find any Javadoc files. You can mount the filesystem anyway and then set the Root Offset property to the Javadoc top-level directory. |
See also | |
---|---|
Mounting a Filesystem
Configuring a Javadoc Filesystem Removing a Javadoc Filesystem Javadoc Manager |