plugin:report

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

Full name:

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

Description:

Generates the Plugin's documentation report.

Attributes:

  • Requires a Maven 2.0 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
goalPrefix String 2.4 The goal prefix that will appear before the ":".
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>

Parameter Details

goalPrefix:

The goal prefix that will appear before the ":".
  • 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