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:

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

Legal Notices