javadoc:fix

Full name:

org.apache.maven.plugins:maven-javadoc-plugin:3.1.1:fix

Description:

Fix Javadoc documentation and tags for the Java code for the project. See Where Tags Can Be Used.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Since version: 2.6.
  • Invokes the execution of the lifecycle phase compile prior to executing itself.

Optional Parameters

Name Type Since Description
<comparisonVersion> String 2.6 Version to compare the current code against using the Clirr Maven Plugin.
See defaultSince.
Default value is: (,${project.version}).
User property is: comparisonVersion.
<defaultAuthor> String 2.6 Default value for the Javadoc tag @author.
If not specified, the user.name defined in the System properties will be used.
User property is: defaultAuthor.
<defaultSince> String 2.6 Default value for the Javadoc tag @since.
Default value is: ${project.version}.
User property is: defaultSince.
<defaultVersion> String 2.6 Default value for the Javadoc tag @version.
By default, it is $Id:$, corresponding to a SVN keyword. Refer to your SCM to use an other SCM keyword.
Default value is: $Id: $Id.
User property is: defaultVersion.
<encoding> String 2.6 The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.
Default value is: ${project.build.sourceEncoding}.
User property is: encoding.
<excludes> String 2.6 Comma separated excludes Java files, i.e. **/*Test.java.
User property is: excludes.
<fixClassComment> boolean 2.6 Flag to fix the classes or interfaces Javadoc comments according the level.
Default value is: true.
User property is: fixClassComment.
<fixFieldComment> boolean 2.6 Flag to fix the fields Javadoc comments according the level.
Default value is: true.
User property is: fixFieldComment.
<fixMethodComment> boolean 2.6 Flag to fix the methods Javadoc comments according the level.
Default value is: true.
User property is: fixMethodComment.
<fixTags> String 2.6 Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are:
  • all (fix all Javadoc tags)
  • author (fix only @author tag)
  • version (fix only @version tag)
  • since (fix only @since tag)
  • param (fix only @param tag)
  • return (fix only @return tag)
  • throws (fix only @throws tag)
  • link (fix only @link tag)

Default value is: all.
User property is: fixTags.
<force> boolean 2.6 Forcing the goal execution i.e. skip warranty messages (not recommended).
User property is: force.
<ignoreClirr> boolean 2.6 Flag to ignore or not Clirr.
Default value is: false.
User property is: ignoreClirr.
<includes> String 2.6 Comma separated includes Java files, i.e. **/*Test.java. Note: default value is **\/*.java.
Default value is: **\/*.java.
User property is: includes.
<level> String 2.6 Specifies the access level for classes and members to show in the Javadocs. Possible values are:
  • public (shows only public classes and members)
  • protected (shows only public and protected classes and members)
  • package (shows all classes and members not marked private)
  • private (shows all classes and members)

Default value is: protected.
User property is: level.
<localRepository> ArtifactRepository 2.6 The local repository where the artifacts are located, used by the tests.
User property is: localRepository.
<outputDirectory> File 2.6 Output directory where Java classes will be rewritten.
Default value is: ${project.build.sourceDirectory}.
User property is: outputDirectory.
<removeUnknownThrows> boolean 2.6

Flag to remove throws tags from unknown classes.

NOTE:Since 3.1.0 the default value has been changed to true, due to JavaDoc 8 strictness.


Default value is: true.
User property is: removeUnknownThrows.

Parameter Details

<comparisonVersion>

Version to compare the current code against using the Clirr Maven Plugin.
See defaultSince.
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • User Property: comparisonVersion
  • Default: (,${project.version})

<defaultAuthor>

Default value for the Javadoc tag @author.
If not specified, the user.name defined in the System properties will be used.
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • User Property: defaultAuthor

<defaultSince>

Default value for the Javadoc tag @since.
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • User Property: defaultSince
  • Default: ${project.version}

<defaultVersion>

Default value for the Javadoc tag @version.
By default, it is $Id:$, corresponding to a SVN keyword. Refer to your SCM to use an other SCM keyword.
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • User Property: defaultVersion
  • Default: $Id: $Id

<encoding>

The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • User Property: encoding
  • Default: ${project.build.sourceEncoding}

<excludes>

Comma separated excludes Java files, i.e. **/*Test.java.
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • User Property: excludes

<fixClassComment>

Flag to fix the classes or interfaces Javadoc comments according the level.
  • Type: boolean
  • Since: 2.6
  • Required: No
  • User Property: fixClassComment
  • Default: true

<fixFieldComment>

Flag to fix the fields Javadoc comments according the level.
  • Type: boolean
  • Since: 2.6
  • Required: No
  • User Property: fixFieldComment
  • Default: true

<fixMethodComment>

Flag to fix the methods Javadoc comments according the level.
  • Type: boolean
  • Since: 2.6
  • Required: No
  • User Property: fixMethodComment
  • Default: true

<fixTags>

Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are:
  • all (fix all Javadoc tags)
  • author (fix only @author tag)
  • version (fix only @version tag)
  • since (fix only @since tag)
  • param (fix only @param tag)
  • return (fix only @return tag)
  • throws (fix only @throws tag)
  • link (fix only @link tag)
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • User Property: fixTags
  • Default: all

<force>

Forcing the goal execution i.e. skip warranty messages (not recommended).
  • Type: boolean
  • Since: 2.6
  • Required: No
  • User Property: force

<ignoreClirr>

Flag to ignore or not Clirr.
  • Type: boolean
  • Since: 2.6
  • Required: No
  • User Property: ignoreClirr
  • Default: false

<includes>

Comma separated includes Java files, i.e. **/*Test.java. Note: default value is **\/*.java.
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • User Property: includes
  • Default: **\/*.java

<level>

Specifies the access level for classes and members to show in the Javadocs. Possible values are:
  • public (shows only public classes and members)
  • protected (shows only public and protected classes and members)
  • package (shows all classes and members not marked private)
  • private (shows all classes and members)
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • User Property: level
  • Default: protected

<localRepository>

The local repository where the artifacts are located, used by the tests.
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Since: 2.6
  • Required: No
  • User Property: localRepository

<outputDirectory>

Output directory where Java classes will be rewritten.
  • Type: java.io.File
  • Since: 2.6
  • Required: No
  • User Property: outputDirectory
  • Default: ${project.build.sourceDirectory}

<removeUnknownThrows>

Flag to remove throws tags from unknown classes.

NOTE:Since 3.1.0 the default value has been changed to true, due to JavaDoc 8 strictness.

  • Type: boolean
  • Since: 2.6
  • Required: No
  • User Property: removeUnknownThrows
  • Default: true