Apache Maven 1.x has reached its end of life, and is no longer supported. For more information, see the announcement. Users are encouraged to migrate to the current version of Apache Maven.

Javadoc Settings

Property Optional? Description Default
maven.javadoc.additionalparam Yes Specifies additional parameters added to the javadoc command line.

Example (to print what version of javadoc you are using):

maven.javadoc.additionalparam=-J-showversion
 (none)
maven.javadoc.extrasourcepath Yes A colon- or semicolon-separated list of paths that are added to the sourcepath parameter of the ant javadoc task. This can be used to add paths for inherited javadocs. (none)
maven.javadoc.debug Yes Print informations to debug the plugin. false
maven.javadoc.excludepackagenames Yes Comma separated list of packages to exclude from the javadoc. (none)
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.

(none)
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. 512m
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. (none)
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. 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. (none)
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. no
maven.javadoc.failonerror Yes Stop the buildprocess if the command exits with a returncode other than 0. false
maven.javadoc.javadocreport Yes Include the javadoc report. true
maven.javadoc.warningsreport Yes Include the javadoc warnings report. true

Standard Doclet Settings

Property Optional? Description Default
maven.javadoc.author Yes Boolean value. Specifies whether or not the @author text is included in the generated Javadocs. true
maven.javadoc.bottom Yes Specifies the text to be placed at the bottom of each output file. ${pom.organization.name} expands to value obtained from the project descriptor. Copyright ${year} ${pom.organization.name}. All Rights Reserved.
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.customtags=tag1 tag2
tag1.name=todo
tag1.description=To Do:
tag1.enabled=true
tag1.scope=all

tag2.name=task
tag2.description=Task:
tag2.enabled=false
tag2.scope=all
Note: Due to a bug in the jexl expression evaluator, custom tag names defined by this property cannot contain dashes. 		(none)
maven.javadoc.destdir Yes The destination directory for all of the generated Javadocs. ${maven.docs.dest}/apidocs
maven.javadoc.footer Yes Specifies the text or html fragment to be placed to the right of the bottom navigation bar on all pages. If the footer is not set, but the header is, then Javadoc will use the header in both places. (none)
maven.javadoc.header Yes Specifies the text or html fragment to be placed at the top of the navigation frame in the upper-left corner, and to the right of the top navigation bar on all pages. Javadoc will be use this as the footer as well if the footer is not set explicitly. (none)
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.

 (none)
maven.javadoc.mode.online Yes

If set, a value of true forces generation of javadoc in online mode (using ${maven.javadoc.links}).

Any other value means false and forces generation of javadoc in offline mode (using ${maven.javadoc.offlineLinks}).

This tag allows you to generate javadoc in mode different from the "general" online/offline mode ${maven.mode.online}.

${maven.mode.online}
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.

See the FAQ for more details.

 (none)
maven.javadoc.stylesheet Yes Specifies the stylesheet file to use for the javadoc. ${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. (none)
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. (none)
maven.javadoc.use Yes Boolean value. If true, a "use" page is generated for each class and member. true
maven.javadoc.version Yes Specifies whether or not the @version text is included in the generated Javadocs. true
maven.javadoc.windowtitle Yes Specifies the window title and the doc title to use for the generated Javadocs. ${pom.name} and ${maven.currentVersion} expand to values obtained from the project descriptor. ${pom.name} ${pom.currentVersion} API

Alternate Doclet Settings

Name Optional? Description Default
maven.javadoc.doclet Yes Specifies the doclet to use when calling javadoc. See the ant javadoc task documentation for more detail. See Class Diagrams FAQ as an example. (none - calls the JavaDoc standard doclet)
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. (none)
maven.javadoc.usestandardparameters Yes If this option is set (to a any value), javadoc will use the standard doclet parameters (see above) even if the maven.javadoc.doclet option is set. This is useful for doclets that extend the standard one. When specifying an alternate doclet, the plugin does not use the standard doclet parameters unless this property is set. (none)
maven.javadoc.doclet.param.list Yes

Delimeter separated list of property names (see maven.javadoc.doclet.param.list.delim), with each property defining a parameter name and value, to pass to the doclet. For example: umlgraph.all,property2.abc,property3.def

For every property listed, it expects 2 additional properties:

(propertyname).name
The name of the parameter to pass to the doclet.
(propertyname).value
The value of the parameter to pass to the doclet. Note that this can be not specified, if the parameter name is all that is needed.

For example, to specify the "-all" parameter to the doclet and "-all" does not have a parameter value: 

maven.javadoc.doclet.param.list=umlgraph.all
umlgraph.all.name=-all

(none)
maven.javadoc.doclet.param.list.delim Yes

Property name delimeter for list of parameters specified in maven.javadoc.doclet.param.list.

, (comma)

Other Settings

Type Name Optional? Description
Property maven.compile.encoding Yes Sets the encoding of the .java files being documented (and compiled).
Property maven.docs.outputencoding Yes The character encoding for generated documentation. This value is used as charset and docencoding for the standard doclet.
Project descriptor pom.package No (<= 1.6)

Yes (>= 1.7)		 The package used as root for the javadoc.