taglist:taglist

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

Full name:

org.codehaus.mojo:taglist-maven-plugin:2.2:taglist

Description:

Scans the source files for tags and generates a report on their occurrences.

Attributes:

  • Requires a Maven 2.0 project to be executed.

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 or from a build life cycle phase. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead. Default value is: ${project.reporting.outputDirectory}.

Optional Parameters

Name Type Since Description
aggregate boolean - Whether to build an aggregated report at the root, or build individual reports. Default value is: false.
emptyComments boolean - This parameter indicates whether to look for tags even if they don't have a comment. Default value is: true.
linkXRef boolean - Link the tag line numbers to the source xref. Defaults to true and will link automatically if jxr plugin is being used. Default value is: true.
multipleLineComments boolean - This parameter indicates whether for simple tags (like "TODO"), the analyser should look for multiple line comments. Default value is: true.
showEmptyDetails boolean 2.2 This parameter indicates whether to generate details for tags with zero occurrences. Default value is: false.
tags String[] - List of tags to look for, specified as <tag> tags. The tags can be either:
  • Javadoc tags: "@todo" for instance
  • Simple tags: "TODO" for instance. In this case, the tags will be searched in any Java comment (//, /* or /**).
testXrefLocation File - Location of the Test Xrefs to link to. Default value is: ${project.reporting.outputDirectory}/xref-test.
xrefLocation File - Location of the Xrefs to link to. Default value is: ${project.reporting.outputDirectory}/xref.

Parameter Details

aggregate: Whether to build an aggregated report at the root, or build individual reports.
  • Type: boolean
  • Required: No
  • Expression: ${aggregate}
  • Default: false
emptyComments: This parameter indicates whether to look for tags even if they don't have a comment.
  • Type: boolean
  • Required: No
  • Default: true
linkXRef: Link the tag line numbers to the source xref. Defaults to true and will link automatically if jxr plugin is being used.
  • Type: boolean
  • Required: No
  • Expression: ${linkXRef}
  • Default: true
multipleLineComments: This parameter indicates whether for simple tags (like "TODO"), the analyser should look for multiple line comments.
  • Type: boolean
  • Required: No
  • Default: true
outputDirectory: The output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line or from a build life cycle phase. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}
showEmptyDetails: This parameter indicates whether to generate details for tags with zero occurrences.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Default: false
tags: List of tags to look for, specified as <tag> tags. The tags can be either:
  • Javadoc tags: "@todo" for instance
  • Simple tags: "TODO" for instance. In this case, the tags will be searched in any Java comment (//, /* or /**).
  • Type: java.lang.String[]
  • Required: No
testXrefLocation: Location of the Test Xrefs to link to.
  • Type: java.io.File
  • Required: No
  • Default: ${project.reporting.outputDirectory}/xref-test
xrefLocation: Location of the Xrefs to link to.
  • Type: java.io.File
  • Required: No
  • Default: ${project.reporting.outputDirectory}/xref