javadoc:fix

Full name:

org.apache.maven.plugins:maven-javadoc-plugin:2.8: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}).
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.
defaultSince String 2.6 Default value for the Javadoc tag @since.

Default value is: ${project.version}.
defaultVersion String 2.6 Default value for the Javadoc tag @version.
By default, it is $Id: fix-mojo.html 829398 2012-08-19 17:38:59Z hboutemy $, corresponding to a SVN keyword. Refer to your SCM to use an other SCM keyword.
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}.
excludes String 2.6 Comma separated excludes Java files, i.e. **/*Test.java.
fixClassComment boolean 2.6 Flag to fix the classes or interfaces Javadoc comments according the level.
Default value is: true.
fixFieldComment boolean 2.6 Flag to fix the fields Javadoc comments according the level.
Default value is: true.
fixMethodComment boolean 2.6 Flag to fix the methods Javadoc comments according the level.
Default value is: true.
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)

Default value is: all.
force boolean 2.6 Forcing the goal execution i.e. skip warranty messages (not recommended).
ignoreClirr boolean 2.6 Flag to ignore or not Clirr.
Default value is: false.
includes String 2.6 Comma separated includes Java files, i.e. **/*Test.java.
Default value is: **/*.java.
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.
localRepository ArtifactRepository 2.6 The local repository where the artifacts are located, used by the tests.
outputDirectory File 2.6 Output directory where Java classes will be rewritten.
Default value is: ${project.build.sourceDirectory}.

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
  • Expression: ${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
  • Expression: ${defaultAuthor}

defaultSince:

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

defaultVersion:

Default value for the Javadoc tag @version.
By default, it is $Id: fix-mojo.html 829398 2012-08-19 17:38:59Z hboutemy $, corresponding to a SVN keyword. Refer to your SCM to use an other SCM keyword.
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • Expression: ${defaultVersion}

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
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

excludes:

Comma separated excludes Java files, i.e. **/*Test.java.
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • Expression: ${excludes}

fixClassComment:

Flag to fix the classes or interfaces Javadoc comments according the level.
  • Type: boolean
  • Since: 2.6
  • Required: No
  • Expression: ${fixClassComment}
  • Default: true

fixFieldComment:

Flag to fix the fields Javadoc comments according the level.
  • Type: boolean
  • Since: 2.6
  • Required: No
  • Expression: ${fixFieldComment}
  • Default: true

fixMethodComment:

Flag to fix the methods Javadoc comments according the level.
  • Type: boolean
  • Since: 2.6
  • Required: No
  • Expression: ${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)
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • Expression: ${fixTags}
  • Default: all

force:

Forcing the goal execution i.e. skip warranty messages (not recommended).
  • Type: boolean
  • Since: 2.6
  • Required: No
  • Expression: ${force}

ignoreClirr:

Flag to ignore or not Clirr.
  • Type: boolean
  • Since: 2.6
  • Required: No
  • Expression: ${ignoreClirr}
  • Default: false

includes:

Comma separated includes Java files, i.e. **/*Test.java.
  • Type: java.lang.String
  • Since: 2.6
  • Required: No
  • Expression: ${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
  • Expression: ${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
  • Expression: ${localRepository}

outputDirectory:

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