Adding a Javadoc Library to a Project
See Also
A Javadoc library is any directory, archive file, or server that contains
Javadoc documentation for the code your project uses. Javadoc libraries 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 add the Javadoc library 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 add myPackage/docs/apidocs as the library.
If you want to work with the Javadoc files from a group of JAR or zip files,
each file must be added individually. If the archive file's top-level directory
is not the Javadoc top-level directory, you have to set the Root Offset for
the library in the Javadoc Manager (see below).
To add a Javadoc library:
- From the main window, choose Tools
Javadoc Manager.
- In the Javadoc Manager, add the library 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. You cannot access Javadoc files in HTTP servers
if you are using a proxy to connect to the Internet.
- Modify the library's properties to your preferred settings:
- Hidden. If True, this library is not visible in the
Filesystems window.
- 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