Fork me on GitHub
Built by Maven

jdepend:generate

Note:

This goal should be used as a Maven report.

Full name:

org.codehaus.mojo:jdepend-maven-plugin:2.2.0:generate

Description:

Run JDepend and generate a site report. Goal which generate the JDepend metrics.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2.0.
  • Invokes the execution of the following lifecycle phase prior to executing itself: compile.

Required Parameters

Name Type Since Description
<classDirectory> String - Directory containing the class files.
Default: ${project.build.outputDirectory}
User Property: jdepend.classDirectory
<outputDirectory> String - Directory where the generated output site files will be located.
Default: ${project.build.directory}/site
User Property: jdepend.outputDirectory

Optional Parameters

Name Type Since Description
<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}
<projectDirectory> String - Directory of the project.
Default: ${basedir}
User Property: jdepend.projectDirectory
<siteDirectory> File - Directory containing the site.xml file.
Default: ${basedir}/src/site
<skip> boolean - Skip execution of the plugin.
Default: false
User Property: jdepend.skip

Parameter Details

<classDirectory>

Directory containing the class files.
  • Type: java.lang.String
  • Required: Yes
  • User Property: jdepend.classDirectory
  • Default: ${project.build.outputDirectory}

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

Directory where the generated output site files will be located.
  • Type: java.lang.String
  • Required: Yes
  • User Property: jdepend.outputDirectory
  • Default: ${project.build.directory}/site

<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}

<projectDirectory>

Directory of the project.
  • Type: java.lang.String
  • Required: No
  • User Property: jdepend.projectDirectory
  • Default: ${basedir}

<siteDirectory>

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

<skip>

Skip execution of the plugin.
  • Type: boolean
  • Required: No
  • User Property: jdepend.skip
  • Default: false