plugin:report

Note:This goal should be used as a Maven report.

Full name:

org.apache.maven.plugins:maven-plugin-plugin:2.9:report

Description:

Generates the Plugin's documentation report.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 2.0.
  • Invokes the execution of the lifecycle phase compile prior to executing itself.

Optional Parameters

Name Type Since Description
encoding String 2.7 The file encoding of the source files.
Default value is: ${project.build.sourceEncoding}.
goalPrefix String 2.4 The goal prefix that will appear before the ":". By default, this plugin applies a heuristic to derive a heuristic from the plugin's artifactId. It removes any occurrences of the regular expression -?maven-?, and then removes any occurrences of -?plugin-?.

For example, horsefeature-maven-plugin becomes horsefeather.

(There is a special for maven-plugin-plugin; it is mapped to 'plugin'.
outputDirectory File 2.0 Report output directory.
Default value is: ${project.build.directory}/generated-site/xdoc.
requirements Requirements 2.0 Specify some requirements to execute this plugin. Example: 
<requirements>
  <maven>2.0</maven>
  <jdk>1.4</jdk>
  <memory>256m</memory>
  <diskSpace>1m</diskSpace>
  <others>
    <property>
      <name>SVN</name>
      <value>1.4.6</value>
    </property>
  </others>
</requirements>

skip boolean 2.8 Set this to "true" to skip invoking any goals or reports of the plugin.
Default value is: false.
skipReport boolean 2.8 Set this to "true" to skip generating the report.
Default value is: false.

Parameter Details

encoding:

The file encoding of the source files.
  • Type: java.lang.String
  • Since: 2.7
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

goalPrefix:

The goal prefix that will appear before the ":". By default, this plugin applies a heuristic to derive a heuristic from the plugin's artifactId. It removes any occurrences of the regular expression -?maven-?, and then removes any occurrences of -?plugin-?.

For example, horsefeature-maven-plugin becomes horsefeather.

(There is a special for maven-plugin-plugin; it is mapped to 'plugin'.

  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • Expression: ${goalPrefix}

outputDirectory:

Report output directory.
  • Type: java.io.File
  • Since: 2.0
  • Required: No
  • Default: ${project.build.directory}/generated-site/xdoc

requirements:

Specify some requirements to execute this plugin. Example: 
<requirements>
  <maven>2.0</maven>
  <jdk>1.4</jdk>
  <memory>256m</memory>
  <diskSpace>1m</diskSpace>
  <others>
    <property>
      <name>SVN</name>
      <value>1.4.6</value>
    </property>
  </others>
</requirements>
  • Type: org.apache.maven.plugin.plugin.Requirements
  • Since: 2.0
  • Required: No

skip:

Set this to "true" to skip invoking any goals or reports of the plugin.
  • Type: boolean
  • Since: 2.8
  • Required: No
  • Expression: ${maven.plugin.skip}
  • Default: false

skipReport:

Set this to "true" to skip generating the report.
  • Type: boolean
  • Since: 2.8
  • Required: No
  • Expression: ${maven.plugin.report.skip}
  • Default: false