Built by Maven

plugin-report:report-no-fork

Note:

This goal should be used as a Maven report.

Full name:

org.apache.maven.plugins:maven-plugin-report-plugin:3.15.0:report-no-fork

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.14.0.

Required Parameters

Name Type Since Description
<outputDirectory> File - The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().


Default: ${project.build.directory}/reports

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: 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: false
User Property: maven.plugin.report.hasExtensionsToLoad
<locale> String - The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String)
Default: default
<outputFormat> String - The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
User Property: output.format
<outputTimestamp> String - Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
Default: ${project.build.outputTimestamp}
<requirementsHistories> List<RequirementsHistory> 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>
<requirementsHistoryDetectionRange> String 3.12.0 Plugin's version range for automatic detection of requirements history.
Default: [0,)
<siteDirectory> File - Directory containing the site.xml file.
Default: ${basedir}/src/site
<skip> boolean 3.7.0 Set this to "true" to skip generating the report.
Default: false
User Property: 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

<locale>

The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String)
  • Type: java.lang.String
  • Required: No
  • Default: default

<outputDirectory>

The shared output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().

  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/reports

<outputFormat>

The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
  • Type: java.lang.String
  • Required: No
  • User Property: output.format

<outputTimestamp>

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.outputTimestamp}

<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<org.apache.maven.plugin.plugin.report.RequirementsHistory>
  • Since: 3.7.0
  • Required: No

<requirementsHistoryDetectionRange>

Plugin's version range for automatic detection of requirements history.
  • Type: java.lang.String
  • Since: 3.12.0
  • Required: No
  • Default: [0,)

<siteDirectory>

Directory containing the site.xml file.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/site

<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