Fork me on GitHub
Built by Maven

taglist:taglist

Note:

This goal should be used as a Maven report.

Full name:

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

Description:

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

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2.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
<xmlOutputDirectory> File 2.3 Specifies the directory where the xml taglist.xml output will be generated.
The xml report has a format.
Default: ${project.build.directory}/taglist

Optional Parameters

Name Type Since Description
<aggregate> boolean - Whether to build an aggregated report at the root, or build individual reports.
Default: false
User Property: taglists.aggregate
<emptyComments> boolean - This parameter indicates whether to look for tags even if they don't have a comment.
Default: true
<excludes> String[] 3.0.0 List of files to exclude. Specified as fileset patterns which are relative to the source directory.
<includes> String[] 3.0.0 List of files to include. Specified as fileset patterns which are relative to the source directory.
Default: **/*.java
<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: true
User Property: taglists.linkXRef
<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
<multipleLineComments> boolean - This parameter indicates whether for simple tags (like "TODO"), the analyzer should look for multiple line comments.
Default: true
<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}
<showEmptyDetails> boolean 2.2 This parameter indicates whether to generate details for tags with zero occurrences.
Default: false
<siteDirectory> File - Directory containing the site.xml file.
Default: ${basedir}/src/site
<skipEmptyReport> boolean 3.1.0 Skip generating report if no tags found in sources.
Default: false
User Property: taglist.skipEmptyReport
<skipTestSources> boolean 2.4 Skips reporting of test sources.
Default: false
<sourceFileLocale> String 2.4 Specifies the Locale of the source files. Syntax is like "en", "en_US" or "en_US_win".
Default: en
User Property: sourceFileLocale
<tagListOptions> TagListOptions 2.4 Defines each tag class (grouping) and the individual tags within each class. The user can also specify a title for each tag class and the matching logic used by each tag.
  • Exact Match
    <matchString>todo</matchString>
    <matchType>exact</matchType>
    Matches: todo
  • Ignore Case Match
    <matchString>todo</matchString>
    <matchType>ignoreCase</matchType>
    Matches: todo, Todo, TODO...
  • Regular Expression Match
    <matchString>tod[aeo]</matchString>
    <matchType>regEx</matchType>
    Matches: toda, tode, todo


For complete examples see the Usage page.
Type description taglistOptions
<testXrefLocation> File - Location where Test Source XRef is generated for this project.
Default: org.apache.maven.reporting.AbstractMavenReport.getReportOutputDirectory() + /xref-test
<xrefLocation> File - Location where Source XRef is generated for this project.
Default: org.apache.maven.reporting.AbstractMavenReport.getReportOutputDirectory() + /xref

Parameter Details

<aggregate>

Whether to build an aggregated report at the root, or build individual reports.
  • Type: boolean
  • Required: No
  • User Property: taglists.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

<excludes>

List of files to exclude. Specified as fileset patterns which are relative to the source directory.
  • Type: java.lang.String[]
  • Since: 3.0.0
  • Required: No

<includes>

List of files to include. Specified as fileset patterns which are relative to the source directory.
  • Type: java.lang.String[]
  • Since: 3.0.0
  • Required: No
  • Default: **/*.java

<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
  • User Property: taglists.linkXRef
  • Default: true

<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

<multipleLineComments>

This parameter indicates whether for simple tags (like "TODO"), the analyzer should look for multiple line comments.
  • Type: boolean
  • Required: No
  • Default: true

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

<showEmptyDetails>

This parameter indicates whether to generate details for tags with zero occurrences.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • Default: false

<siteDirectory>

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

<skipEmptyReport>

Skip generating report if no tags found in sources.
  • Type: boolean
  • Since: 3.1.0
  • Required: No
  • User Property: taglist.skipEmptyReport
  • Default: false

<skipTestSources>

Skips reporting of test sources.
  • Type: boolean
  • Since: 2.4
  • Required: No
  • Default: false

<sourceFileLocale>

Specifies the Locale of the source files. Syntax is like "en", "en_US" or "en_US_win".
  • Type: java.lang.String
  • Since: 2.4
  • Required: No
  • User Property: sourceFileLocale
  • Default: en

<tagListOptions>

Defines each tag class (grouping) and the individual tags within each class. The user can also specify a title for each tag class and the matching logic used by each tag.
  • Exact Match
    <matchString>todo</matchString>
    <matchType>exact</matchType>
    Matches: todo
  • Ignore Case Match
    <matchString>todo</matchString>
    <matchType>ignoreCase</matchType>
    Matches: todo, Todo, TODO...
  • Regular Expression Match
    <matchString>tod[aeo]</matchString>
    <matchType>regEx</matchType>
    Matches: toda, tode, todo


For complete examples see the Usage page.
Type description taglistOptions
  • Type: org.codehaus.mojo.taglist.options.TagListOptions
  • Since: 2.4
  • Required: No

<testXrefLocation>

Location where Test Source XRef is generated for this project.
Default: org.apache.maven.reporting.AbstractMavenReport.getReportOutputDirectory() + /xref-test
  • Type: java.io.File
  • Required: No

<xmlOutputDirectory>

Specifies the directory where the xml taglist.xml output will be generated.
The xml report has a format.
  • Type: java.io.File
  • Since: 2.3
  • Required: Yes
  • Default: ${project.build.directory}/taglist

<xrefLocation>

Location where Source XRef is generated for this project.
Default: org.apache.maven.reporting.AbstractMavenReport.getReportOutputDirectory() + /xref
  • Type: java.io.File
  • Required: No