Built by Maven

javadoc:fix

Full name:

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

Description:

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

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.6.
  • Invokes the execution of the following lifecycle phase prior to executing itself: compile.

Optional Parameters

Name Type Since Description
<comparisonVersion> String - Version to compare the current code against using the Clirr Maven Plugin.
See defaultSince.
Default: (,${project.version})
User Property: comparisonVersion
<defaultAuthor> String - Default value for the Javadoc tag @author.
Default: ${user.name}
User Property: defaultAuthor
<defaultSince> String - Default value for the Javadoc tag @since.
Default: ${project.version}
User Property: defaultSince
<defaultVersion> String - Default value for the Javadoc tag @version.
User Property: defaultVersion
<encoding> String - 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: ${project.build.sourceEncoding}
User Property: encoding
<excludes> String - Comma separated excludes Java files, i.e. **/*Test.java.
User Property: excludes
<fixClassComment> boolean - Flag to fix the classes or interfaces Javadoc comments according the level.
Default: true
User Property: fixClassComment
<fixFieldComment> boolean - Flag to fix the fields Javadoc comments according the level.
Default: true
User Property: fixFieldComment
<fixMethodComment> boolean - Flag to fix the methods Javadoc comments according the level.
Default: true
User Property: fixMethodComment
<fixTags> String - 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: all
User Property: fixTags
<force> boolean - Forcing the goal execution i.e. skip warranty messages (not recommended).
User Property: force
<ignoreClirr> boolean - Flag to ignore or not Clirr.
Default: false
User Property: ignoreClirr
<includes> String - Comma separated includes Java files, i.e. **/*Test.java.

Note: default value is **\/*.java.
Default: **\/*.java
User Property: includes
<level> String - 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)

See also: private, protected, public, package options for Javadoc
Default: protected
User Property: level
<outputDirectory> File - Output directory where Java classes will be rewritten.
Default: ${project.build.sourceDirectory}
User Property: outputDirectory
<removeUnknownThrows> boolean -

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: true
User Property: removeUnknownThrows

Parameter Details

<comparisonVersion>

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

<defaultAuthor>

Default value for the Javadoc tag @author.
  • Type: java.lang.String
  • Required: No
  • User Property: defaultAuthor
  • Default: ${user.name}

<defaultSince>

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

<defaultVersion>

Default value for the Javadoc tag @version.
  • Type: java.lang.String
  • Required: No
  • User Property: 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
  • Required: No
  • User Property: encoding
  • Default: ${project.build.sourceEncoding}

<excludes>

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

<fixClassComment>

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

<fixFieldComment>

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

<fixMethodComment>

Flag to fix the methods Javadoc comments according the level.
  • Type: boolean
  • 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
  • Required: No
  • User Property: fixTags
  • Default: all

<force>

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

<ignoreClirr>

Flag to ignore or not Clirr.
  • Type: boolean
  • 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
  • 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)

See also: private, protected, public, package options for Javadoc
  • Type: java.lang.String
  • Required: No
  • User Property: level
  • Default: protected

<outputDirectory>

Output directory where Java classes will be rewritten.
  • Type: java.io.File
  • 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
  • Required: No
  • User Property: removeUnknownThrows
  • Default: true