| Property | Optional? | Description |
|---|---|---|
| maven.javadoc.additionalparam | Yes |
Specifies additional parameters added to the javadoc command line.
Example (sets generated Javadocs encoding to utf-8): |
| 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.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.debug | Yes |
Print informations to debug the plugin.
The default value is false.
|
| maven.javadoc.destdir | Yes |
The destination directory for all of the generated
Javadocs. The default value is
${maven.docs.dest}/apidocs.
|
| maven.javadoc.doclet | Yes | Specifies the doclet to use when calling javadoc. See the ant javadoc task documentation for more detail. |
| maven.javadoc.docletpath | Yes | Specifies the path to the doclet class when calling javadoc with a custom doclet. See the ant javadoc task documentation for more detail. |
| maven.javadoc.excludepackagenames | Yes | Comma separated list of packages to exclude from the javadoc. |
| 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. The URLs must link to a directory where the javadoc generated file "package-list" is accesible for the package. Example: |
| maven.javadoc.locale | Yes |
Locale to be used, e.g. en_US or en_US_WIN. Works like the "-locale" option of the javadoc command. |
| maven.javadoc.maxmemory | Yes |
Specifies the maximum Java heap size to be used when launching
the javadoc executable. Some JVMs refer to this property as
the -Xmx parameter.
|
| maven.javadoc.mode.online | Yes |
Default value is
If set, a value of
Any other value means
This tag allows you to generate javadoc in mode different from the
"general" online/offline mode |
| maven.javadoc.offlineLinks | Yes |
Comma separated list of URLs to create links to javadoc output of other packages in offline mode (see properties maven.online.mode and 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. |
| maven.javadoc.stylesheet | Yes |
Specifies the stylesheet file to use for the javadoc.
Default is ${plugin.resources}/stylesheet.css
|
| maven.javadoc.tagletpath | Yes | Specifies the path to the taglet classes when calling javadoc with taglets. See the ant javadoc task documentation for more detail. |
| maven.javadoc.taglets | Yes | Comma separated list of taglet classes to use when calling javadoc (use fully-qualified class names). You must also set maven.javadoc.tagletpath. See the ant javadoc task documentation for more detail. |
| maven.javadoc.use | Yes |
Boolean value.
If true, a "use" page is generated for each class and member.
The default value is true.
|
| 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 |
Specifies whether or not the @version text is
included in the generated Javadocs. The default value is
true.
|
| maven.javadoc.windowtitle | Yes |
Specifies the window title to use for the generated
Javadocs. The default value is
${pom.name} ${pom.currentVersion} API.
${pom.name} and ${maven.currentVersion}
expand to values obtained from the project descriptor.
|
| maven.javadoc.copyright | Yes |
Specifies the copyright notice. The default value is
${pom.organization.name}
expand to value obtained from the project descriptor.
|
| Type | Name | Optional? | Description |
|---|---|---|---|
| Property | maven.compile.encoding | Yes | Sets the encoding of the .java files being documented (and compiled). |
| Project descriptor | pom.package | Yes | The package used as root for the javadoc. |