plugin:report
Note:This goal should be used as a Maven report.
Full name:
org.apache.maven.plugins:maven-plugin-plugin:3.8.1:report
This plugin goal has been deprecated:
Description:
plugin-info.html
plugin overview page, and one goal-mojo.html
per goal. Relies on one output file from org.apache.maven.plugin.plugin.DescriptorGeneratorMojo
.Attributes:
- Requires a Maven project to be executed.
- The goal is thread-safe and supports parallel builds.
- Since version:
2.0
. - Invokes the execution of the lifecycle phase
process-classes
prior to executing itself.
Optional Parameters
Name | Type | Since | Description |
---|---|---|---|
<disableInternalJavadocLinkValidation> |
boolean |
3.7.0 |
In case the internal javadoc site has not been generated when running this report goal (e.g. when using an aggregator javadoc report) link validation needs to be disabled by setting this value to true . This might have the drawback that some links being generated in the report might be broken in case not all parameter types and javadoc link references are resolvable through the sites being given to org.apache.maven.plugin.plugin.DescriptorGeneratorMojo .User property is: maven.plugin.report.disableInternalJavadocLinkValidation . |
<encoding> |
String |
2.7 |
Deprecated. The file encoding of the source files. Default value is: ${project.build.sourceEncoding} .User property is: encoding . |
<goalPrefix> |
String |
2.4 |
Deprecated.
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 horsefeature. (There is a special case for maven-plugin-plugin: it is mapped to 'plugin') User property is: goalPrefix . |
<hasExtensionsToLoad> |
boolean |
3.7.0 |
Set this to "true" to generate the usage section for "plugin-info.html" with <extensions>true</extensions> .Default value is: false .User property is: maven.plugin.report.hasExtensionsToLoad . |
<outputDirectory> |
File |
- |
Report output directory for mojos' documentation. Default value is: ${project.build.directory}/generated-site/xdoc . |
<requirements> |
Requirements |
- |
Deprecated. 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> If not is specified, Maven requirement is extracted from |
<requirementsHistories> |
List<RequirementsHistory> |
3.7.0 |
The Plugin requirements history list.
Can be specified as list of <requirementsHistories> <requirementsHistory> <version>plugin version</version> <maven>maven version</maven> <jdk>jdk version</jdk> </requirementsHistory> </requirementsHistories> |
<skip> |
boolean |
2.8 |
Set this to "true" to skip generating the report. Default value is: false .User property is: maven.plugin.report.skip . |
<skipReport> |
boolean |
2.8 |
Deprecated. Set this to "true" to skip invoking any goals or reports of the plugin. Default value is: false .User property is: maven.plugin.skip . |
Parameter Details
<disableInternalJavadocLinkValidation>
true
. This might have the drawback that some links being generated in the report might be broken in case not all parameter types and javadoc link references are resolvable through the sites being given to org.apache.maven.plugin.plugin.DescriptorGeneratorMojo
.- Type:
boolean
- Since:
3.7.0
- Required:
No
- User Property:
maven.plugin.report.disableInternalJavadocLinkValidation
<encoding>
- Type:
java.lang.String
- Since:
2.7
- Required:
No
- User Property:
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 horsefeature.
(There is a special case for maven-plugin-plugin: it is mapped to 'plugin')
- Type:
java.lang.String
- Since:
2.4
- Required:
No
- User Property:
goalPrefix
<hasExtensionsToLoad>
<extensions>true</extensions>
.- Type:
boolean
- Since:
3.7.0
- Required:
No
- User Property:
maven.plugin.report.hasExtensionsToLoad
- Default:
false
<outputDirectory>
- Type:
java.io.File
- Required:
No
- Default:
${project.build.directory}/generated-site/xdoc
<requirements>
<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>
If not is specified, Maven requirement is extracted from <project><prerequisites><maven>
and JDK requirement is extracted from maven-compiler-plugin configuration.
- Type:
org.apache.maven.plugin.plugin.report_old.Requirements
- Required:
No
<requirementsHistories>
Can be specified as list of requirementsHistory
:
<requirementsHistories> <requirementsHistory> <version>plugin version</version> <maven>maven version</maven> <jdk>jdk version</jdk> </requirementsHistory> </requirementsHistories>
- Type:
java.util.List<org.apache.maven.plugin.plugin.report_old.RequirementsHistory>
- Since:
3.7.0
- Required:
No
<skip>
- Type:
boolean
- Since:
2.8
- Required:
No
- User Property:
maven.plugin.report.skip
- Default:
false
<skipReport>
skip
parameter instead- Type:
boolean
- Since:
2.8
- Required:
No
- User Property:
maven.plugin.skip
- Default:
false