Built by Maven

plugin-report:report

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

Full name:

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

Description:

Generates the Plugin's documentation report: plugin-info.html plugin overview page, and one goal-mojo.html per goal. Relies on one output file from plugin:descriptor.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 3.7.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 goal plugin:descriptor.
User property is: maven.plugin.report.disableInternalJavadocLinkValidation.
<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 3.7.0 Report output directory for mojos' documentation.
Default value is: ${project.build.directory}/generated-site/xdoc.
<requirementsHistories> List 3.7.0 The Plugin requirements history list.

Can be specified as list of requirementsHistory:

<requirementsHistories>
  <requirementsHistory>
    <version>plugin version</version>
    <maven>maven version</maven>
    <jdk>jdk version</jdk>
  </requirementsHistory>
</requirementsHistories>

<skip> boolean 3.7.0 Set this to "true" to skip generating the report.
Default value is: false.
User property is: maven.plugin.report.skip.

Parameter Details

<disableInternalJavadocLinkValidation>

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 goal plugin:descriptor.
  • Type: boolean
  • Since: 3.7.0
  • Required: No
  • User Property: maven.plugin.report.disableInternalJavadocLinkValidation

<hasExtensionsToLoad>

Set this to "true" to generate the usage section for "plugin-info.html" with <extensions>true</extensions>.
  • Type: boolean
  • Since: 3.7.0
  • Required: No
  • User Property: maven.plugin.report.hasExtensionsToLoad
  • Default: false

<outputDirectory>

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

<requirementsHistories>

The Plugin requirements history list.

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
  • Since: 3.7.0
  • Required: No

<skip>

Set this to "true" to skip generating the report.
  • Type: boolean
  • Since: 3.7.0
  • Required: No
  • User Property: maven.plugin.report.skip
  • Default: false