The URLs must link to a directory where the javadoc generated file "package-list" is accesible for the package.
+Example:
+The URLs must link to a directory where the javadoc generated file "package-list" is accesible for the package.
+Example (generates offline links in offline mode):
+Generation of online javadoc links in offline mode is also possible. You need to provide the online URL plus the a offline directory resource for "package-list". URL and directory need to be seperated by the "#" character.
+Example (generates online links in offline mode):
+You can set your proxy parameters in the additionnal parameters passed to the javadoc :
+Example (sets generated Javadocs encoding to utf-8):
-@author text is
- included in the generated Javadocs.
- The default value is true.
- ${pom.organization.name}
- expand to value obtained from the project descriptor.
- Example (to print what version of javadoc you are using):
+false.
${maven.docs.dest}/apidocs.
- - Comma separated list of URLs to create links to javadoc output of - other packages in online mode (see properties maven.online.mode and - maven.javadoc.mode.online). - Works like the "-link" option of the javadoc command. -
-- The URLs must link to a directory where the javadoc generated file - "package-list" is accesible for the package. -
-Example:
--Xmx parameter.
true value includes that scope and higher.
+ The default value is to include protected scope and higher.
+ | Property | +Optional? | +Description | +|||||
|---|---|---|---|---|---|---|---|
| maven.javadoc.author | +Yes | +
+ Boolean value.
+ Specifies whether or not the @author text is
+ included in the generated Javadocs.
+ The default value is true.
+ |
+ |||||
| maven.javadoc.bottom | +Yes | +
+ Specifies the text to be placed at the bottom of each output file. The default value is
+ ${pom.organization.name}
+ expand to value obtained from the project descriptor.
+ |
+ |||||
| maven.javadoc.customtags | +Yes | +
+ Specifies custom tags to use for the generated
+ Javadocs. You can specify some tags separate by space.
+ Each tag is describe in sub properties.
+ This option is only available with Java 1.4.
+ Sample :
+ |
+ |||||
| maven.javadoc.destdir | +Yes | +
+ The destination directory for all of the generated
+ Javadocs. The default value is
+ ${maven.docs.dest}/apidocs.
+ |
+ |||||
| maven.javadoc.links | +Yes | +
+ + Comma separated list of URLs to create links to javadoc output of + other packages in online mode (see properties maven.online.mode and + maven.javadoc.mode.online). + Works like the "-link" option of the javadoc command. + +See the FAQ for more details. + |
+ |||||
|
maven.javadoc.mode.online
@@ -198,57 +240,7 @@ maven.javadoc.links=http://java.sun.com/j2se/1.4.2/docs/api/, http://maven.apach
maven.javadoc.mode.online).
Works like the "-linkoffline" option of the javadoc command.
- - The URLs must link to a directory where the javadoc generated file - "package-list" is accesible for the package. - -Example (generates offline links in offline mode): -- Generation of online javadoc links in offline mode is also possible. - You need to provide the online URL plus the a offline directory - resource for "package-list". URL and directory need to be seperated - by the "#" character. - -Example (generates online links in offline mode): - |
- |||||||
| maven.javadoc.overview | -Yes | -- Filename. - Add additional overview documentation to the overview page of the javadoc. - The documentation must be an HTML file, specified relative to the project.xml. - | -|||||
|
- maven.javadoc.public - maven.javadoc.package - maven.javadoc.private - |
- Yes | -
- Boolean value.
- The scope of classes and members to include in the javadoc.
- A true value includes that scope and higher.
- The default value is to include protected scope and higher.
- |
- |||||
| maven.javadoc.source | -Yes | -
- Specifies the version of the jdk in use. See
- the
- ant javadoc task documentation for more detail.
+ See the FAQ for more details. |
|||||
| maven.javadoc.useexternalfile | -Yes | -- indicates whether the sourcefile name specified in srcfiles or as - nested source elements should be written to a temporary file to make - the command line shorter. Default value : no. - | -|||||
| maven.javadoc.version | Yes | @@ -314,7 +297,7 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-apmaven.javadoc.windowtitle | Yes |
- Specifies the window title to use for the generated
+ Specifies the window title and the doc title to use for the generated
Javadocs. The default value is
${pom.name} ${pom.currentVersion} API.
${pom.name} and ${maven.currentVersion}
@@ -344,18 +327,18 @@ maven.javadoc.offlineLinks=http://java.sun.com/j2se/1.4.2/docs/api/#/opt/java-ap
| maven.docs.outputencoding | Yes | - The character encoding for generated documentation. + The character encoding for generated documentation. This value is used as charset and docencoding for the standard doclet. |
| Project descriptor | pom.package | -Yes | +No (<= 1.6) Yes (>= 1.7) |
The package used as root for the javadoc. | -