taglist:taglist
Note:This goal should be used as a Maven report.
Full name:
org.codehaus.mojo:taglist-maven-plugin:3.0.0: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
.
Required Parameters
Name | Type | Since | Description |
---|---|---|---|
<xmlOutputDirectory> |
File |
2.3 |
Specifies the directory where the xml output will be generated. Default value is: ${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 value is: false .User property is: taglists.aggregate . |
<emptyComments> |
boolean |
- |
This parameter indicates whether to look for tags even if they
don't have a comment. Default value is: 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 value is: **/*.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 value is: true .User property is: taglists.linkXRef . |
<multipleLineComments> |
boolean |
- |
This parameter indicates whether for simple tags (like "TODO"), the
analyzer 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 . |
<skipTestSources> |
boolean |
2.4 |
Skips reporting of test sources. Default value is: false . |
<sourceFileLocale> |
String |
2.4 |
Specifies the Locale of the source files. Default value is: en .User property is: 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.
For complete examples see the Usage page. |
<testXrefLocation> |
File |
- |
Location of the Test Xrefs to link to. Default value is: ${project.reporting.outputDirectory}/xref-test .User property is: taglists.testXrefLocation . |
<xrefLocation> |
File |
- |
Location of the Xrefs to link to. Default value is: ${project.reporting.outputDirectory}/xref .User property is: taglists.xrefLocation . |
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
<multipleLineComments>
This parameter indicates whether for simple tags (like "TODO"), the
analyzer should look for multiple line comments.
- Type:
boolean
- Required:
No
- Default:
true
<showEmptyDetails>
This parameter indicates whether to generate details for tags with
zero occurrences.
- Type:
boolean
- Since:
2.2
- Required:
No
- 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.
- 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.
For complete examples see the Usage page.
- 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:
org.codehaus.mojo.taglist.options.TagListOptions
- Since:
2.4
- Required:
No
<testXrefLocation>
Location of the Test Xrefs to link to.
- Type:
java.io.File
- Required:
No
- User Property:
taglists.testXrefLocation
- Default:
${project.reporting.outputDirectory}/xref-test
<xmlOutputDirectory>
Specifies the directory where the xml output will be generated.
- Type:
java.io.File
- Since:
2.3
- Required:
Yes
- Default:
${project.build.directory}/taglist
<xrefLocation>
Location of the Xrefs to link to.
- Type:
java.io.File
- Required:
No
- User Property:
taglists.xrefLocation
- Default:
${project.reporting.outputDirectory}/xref