Javadoc Settings

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

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

maven.doccheck.additionalparam=-J-showversion
maven.doccheck.debug Yes Print informations to debug the plugin. The default value is false.
maven.doccheck.destdir Yes The destination directory for all of the generated Javadocs. The default value is ${maven.docs.dest}/doccheck.
maven.doccheck.doclet Yes

Specifies the doclet to use when calling javadoc. See the ant javadoc task documentation for more detail.

Default value : com.sun.tools.doclets.doccheck.DocCheck.
maven.doccheck.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.

Default value : the DocCheck jar in the local maven repository.
maven.doccheck.excludepackagenames Yes Comma separated list of packages to exclude from the javadoc.
maven.doccheck.locale Yes

Locale to be used, e.g. en_US or en_US_WIN. Works like the "-locale" option of the javadoc command.

maven.doccheck.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.doccheck.public

maven.doccheck.package

maven.doccheck.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.doccheck.source Yes Specifies the version of the jdk in use. See the ant javadoc task documentation for more detail.

DocCheck Doclet Settings

Doclet Settings

Settings specific to the Doc Check Doclet. For more detail of these settings, see here.

Property Optional? Description
maven.doccheck.authorid Yes

Supplies the name used when an @author tag is generated.

Default value : unattributed
maven.doccheck.versionid Yes

Supplies the version string when an @version tag is generated.

Default value : %I% %G%
maven.doccheck.classlist Yes

Generates a list of (outermost) classes that have errors and stores them in a file named classErr.lst.

Default value : false
maven.doccheck.docletid Yes

Identifies the doclet version in the summary page.

Default value : false
maven.doccheck.skip.packages Yes

Comma separated list of package-patterns to skip, where each pattern represents a fully qualified package name. (See Skip List Specifications.)

Default value : blank
maven.doccheck.skip.classes Yes

Comma separated list of classname-patterns to skip, where each pattern represents a fully qualified class name. (See Skip List Specifications.)

Default value : blank
maven.doccheck.evident Yes

The error level to assign to methods missing comments which are "self-evident" by virtue of the method name, where "self-evident" is defined as "so obvious that this doclet can generate a comment for it".

level description
1 Type error
2 Missing comment
3 Tag error
4 Text error
5 Warning

Default value : 2
maven.doccheck.package.depth Yes

The package-depth for the executive summary.

Default value : 1

Text Control Settings

Settings for the initial comment templates. For more detail of these settings, see here.

Property Optional? Description
maven.doccheck.text.interface Yes

The text to use for an interface.

Default value : Determines the requirements for an object that ...
maven.doccheck.text.constructor Yes

The initial text for a constructor.

Default value : Constructs
maven.doccheck.text.constructor.object Yes

The final text for a constructor.

Default value : object
maven.doccheck.text.getter Yes

The text that precedes the property name in a method named getFoo().

Default value : Returns the
maven.doccheck.text.getter.boolean Yes

The text that precedes the property name in a method named isFoo().

Default value : Returns true of this object is
maven.doccheck.text.setter Yes

The text that precedes the property name in a method named setFoo() that sets a non-boolean variable.

Default value : Specifies the
maven.doccheck.text.setter.boolean Yes

The text that precedes the property name in a method named setFoo() that sets a boolean variable.

Default value : Identifies this object as
maven.doccheck.text.value Yes

The text that follows the property name in a method named getFoo() that returns a non-boolean variable and for a method named setFoo() that sets a non-boolean variable.

Default value : value
maven.doccheck.text.value.boolean Yes

The text that follows the property name in a method named isFoo() and for a method named setFoo() that sets a boolean variable.

Default value : blank

Other Settings

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.