jdtaus-container-mojo:report

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

Full name:

org.jdtaus.mojo:jdtaus-container-mojo:3.13:report

Description:

Generates a report for the artifact's container metadata.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.

Required Parameters

Name Type Since Description
outputDirectory File - The 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 output directory configured in Maven Site Plugin is used instead.
Default value is: ${project.reporting.outputDirectory}.

Optional Parameters

Name Type Since Description
buildOutputDirectory File - Build output directory.
javadocDirectory String - Location of the javadoc documentation to link to. Keep this in sync with the javadoc plugin.
Default value is: apidocs.
linkJavadoc boolean - true to generate links to javadoc documentation. false to not generate links to javadoc documentation.
Default value is: true.
moduleName String - Name of the module to generate a report for.
Default value is: ${project.name}.

Parameter Details

buildOutputDirectory:

Build output directory.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/container

javadocDirectory:

Location of the javadoc documentation to link to. Keep this in sync with the javadoc plugin.
  • Type: java.lang.String
  • Required: No
  • Default: apidocs

linkJavadoc:

true to generate links to javadoc documentation. false to not generate links to javadoc documentation.
  • Type: boolean
  • Required: No
  • Default: true

moduleName:

Name of the module to generate a report for.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.name}

outputDirectory:

The 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 output directory configured in Maven Site Plugin is used instead.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}