Javadoc Location Dialog

Javadoc Location Dialog

This dialog lets you define the location of the Javadoc documentation for a JAR or a Java project.
You can reach this dialog the following ways:

Select a JAR or Java project, open the context menu and select Properties > Javadoc Location or use Properties from the File menu

In the Javadoc generation wizard, on the Standard doclet settings page, choose Configure

Javadoc can be attached to JARs, class folders or Java projects. For projects it documents the elements of all source folders, for JARs and class folders, elements contained in the JAR are documented. The location is used by

Open External Javadoc in the Navigate menu to find the Javadoc location of an element

Context Help (F1) to point to a Javadoc location

Javadoc Export Wizard to link to other documentation or as default destination for a project's documentation

Valid locations are URLs that point to a folder containing the API documentation's index.html and package-list file. Examples are:
file:///M:/JAVA/JDK1.2/DOCS/API/
http://java.sun.com/j2se/1.4/docs/api/

Option

Description

Default

Javadoc URL

Specify the location of the generated Javadoc documentation. You can Browse in the local file system for a Javadoc location (will result in a file:// URL)
<empty>

Validate

Validate the current location by trying to access the index.html and package-list file with the given URL. If the validation was successful, you can directly open the documentation.

Javadoc for JARs and class folders can also be located inside an archive available on the local file system. In that case the location of the archive as well as the location of the doc inside the archive has to be specified.

Option

Description

Default

Archive location

Specify the location of the archive that contains the generated Javadoc documentation. You can Browse in the local file system for a Javadoc location
<empty>

Path within archive

Specify the path inside the archive that contains the generated Javadoc documentation. You can Browse to see the content of the archive.
<empty>

Validate

Validate the current location by trying to access the index.html and package-list file with the given URL. If the validation was successful, you can directly open the documentation.

Option	Description	Default
Javadoc URL	Specify the location of the generated Javadoc documentation. You can Browse in the local file system for a Javadoc location (will result in a file:// URL)	<empty>
Validate	Validate the current location by trying to access the index.html and package-list file with the given URL. If the validation was successful, you can directly open the documentation.

Option	Description	Default
Archive location	Specify the location of the archive that contains the generated Javadoc documentation. You can Browse in the local file system for a Javadoc location	<empty>
Path within archive	Specify the path inside the archive that contains the generated Javadoc documentation. You can Browse to see the content of the archive.	<empty>
Validate	Validate the current location by trying to access the index.html and package-list file with the given URL. If the validation was successful, you can directly open the documentation.