Javadoc - touniez/comp402doc GitHub Wiki

All configurable options relating to generating Javadoc.

Access Level (javadoc.access.level = "package")
Specifies the lowest access level for fields and methods to include in the generated documentation. Legal values are "public", "protected", "package", and "private".

Java Version for Javadoc Links (javadoc.link.version = (JDK Version))
Specifies which URL to use when generating links to Java library classes. Legal values are "1.3", "1.4", and "none" if no links to Java library classes are desired. (This option defaults to the version of the user's JDK.)

This setting also controls which of the URLs below is used for the "Open Java API Javadoc" feature.

Javadoc 1.3 URL (javadoc.1.3.link = "http://java.sun.com/j2se/1.3/docs/api")
The URL to use when generating links to JDK 1.3 library classes or opening the Javadoc pages for the Java API.

Javadoc 1.4 URL (javadoc.1.4.link = "http://java.sun.com/j2se/1.4/docs/api")
The URL to use when generating links to JDK 1.4 library classes or opening the Javadoc pages for the Java API.

Javadoc 1.5 URL (javadoc.1.5.link = "http:/java.sun.com/j2se/1.5/docs/api")
The URL to use when generating links to JDK 1.5 library classes or opening the Javadoc pages for the Java API.

Javadoc 1.6 URL (javadoc.1.6.link = "http://java.sun.com/javase/6/docs/api")
The URL to use when generating links to JDK 1.6 library classes or opening the Javadoc pages for the Java API.

JUnit 3.8.2 URL (junit.3.8.2.link = "http://www.cs.rice.edu/~javaplt/javadoc/junit3.8.2")
The URL to use when generating links to JUnit 3.8.2 library classes or opening the Javadoc pages for the Java API.

Additional Javadoc URLs (javadoc.additional.link = [])
A list of URLs used to open Javadoc pages for user-specified libraries. Please enter the URL to the directory that contains the allclasses-frame.html file. For example, to open DrJava's Javadoc, enter http://drjava.org/javadoc/drjava.

Default Destination Directory (javadoc.destination = "")
If a directory is specified, it will be used as the default when generating new documentation.

Custom Javadoc Parameters (javadoc.custom.params = "")
Any custom parameters to pass to the Javadoc tool, separated by spaces. Use "javadoc -help" at a command line to view the available parameters.

Generate Javadoc From Source Roots (javadoc.from.roots = false)
If this option is enabled, then Javadoc will not only search the current package and all subpackages for files, it will also search all "enclosing" packages (those at a higher level).