Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
A
C
E
F
G
I
O
R
S
T
A
addComment(String, int)
- Method in class org.codehaus.mojo.taglist.beans.
FileReport
Adds a new entry to the list of tags found for this file report.
C
canGenerateReport()
- Method in class org.codehaus.mojo.taglist.
TagListReport
Cf.
compareTo(Object)
- Method in class org.codehaus.mojo.taglist.beans.
FileReport
Cf.
compareTo(Object)
- Method in class org.codehaus.mojo.taglist.beans.
TagReport
Cf.
constructSourceDirs()
- Method in class org.codehaus.mojo.taglist.
TagListReport
Construct the list of source directories to analyse.
E
execute()
- Method in class org.codehaus.mojo.taglist.
FileAnalyser
Execute the analysis for the configuration given by the TagListReport.
executeReport(Locale)
- Method in class org.codehaus.mojo.taglist.
TagListReport
Cf.
F
FileAnalyser
- Class in
org.codehaus.mojo.taglist
Class that analyses a file with a special comment tag.
FileAnalyser(TagListReport)
- Constructor for class org.codehaus.mojo.taglist.
FileAnalyser
Constructor.
FileReport
- Class in
org.codehaus.mojo.taglist.beans
Report for a file.
FileReport(File)
- Constructor for class org.codehaus.mojo.taglist.beans.
FileReport
Constructor.
G
generateReport()
- Method in class org.codehaus.mojo.taglist.
ReportGenerator
Generates the whole report using each tag reports made during the analysis.
getBundle()
- Method in class org.codehaus.mojo.taglist.
TagListReport
Returns the correct resource bundle according to the locale.
getClassName()
- Method in class org.codehaus.mojo.taglist.beans.
FileReport
Returns the complete name of the analysed class, for instance: org.codehaus.mojo.taglist.beans.FileReport.
getClassNameWithSlash()
- Method in class org.codehaus.mojo.taglist.beans.
FileReport
Returns the path corresponding to the analysed class, for instance: org/apache/maven/plugins/taglist/beans/FileReport.
getComment(Integer)
- Method in class org.codehaus.mojo.taglist.beans.
FileReport
Returns the comment for the corresponding line index.
getDescription(Locale)
- Method in class org.codehaus.mojo.taglist.
TagListReport
Cf.
getFileReport(File)
- Method in class org.codehaus.mojo.taglist.beans.
TagReport
Returns the FileReport object corresponding to this file.
getFileReports()
- Method in class org.codehaus.mojo.taglist.beans.
TagReport
Returns the collection of file reports for the tag.
getLineIndexes()
- Method in class org.codehaus.mojo.taglist.beans.
FileReport
Returns the list of the comment line indexes.
getName(Locale)
- Method in class org.codehaus.mojo.taglist.
TagListReport
Cf.
getOutputDirectory()
- Method in class org.codehaus.mojo.taglist.
TagListReport
Cf.
getOutputName()
- Method in class org.codehaus.mojo.taglist.
TagListReport
Cf.
getProject()
- Method in class org.codehaus.mojo.taglist.
TagListReport
Cf.
getSiteRenderer()
- Method in class org.codehaus.mojo.taglist.
TagListReport
Cf.
getTagCount()
- Method in class org.codehaus.mojo.taglist.beans.
TagReport
Gives the number of comments found for that tag.
getTagName()
- Method in class org.codehaus.mojo.taglist.beans.
TagReport
Returns the name of the tag that was looked for.
getTags()
- Method in class org.codehaus.mojo.taglist.
TagListReport
Returns the tags to look for.
getTestXrefLocation()
- Method in class org.codehaus.mojo.taglist.
ReportGenerator
Get the test code cross reference location.
getXrefLocation()
- Method in class org.codehaus.mojo.taglist.
ReportGenerator
Get the source code cross reference location.
I
isEmptyComments()
- Method in class org.codehaus.mojo.taglist.
TagListReport
Tells whether to look for tags without comments.
isMultipleLineComments()
- Method in class org.codehaus.mojo.taglist.
TagListReport
Tells whether to look for comments over multiple lines.
isShowEmptyDetails()
- Method in class org.codehaus.mojo.taglist.
TagListReport
Tells whether to generate details for tags with zero occurrences.
O
org.codehaus.mojo.taglist
- package org.codehaus.mojo.taglist
org.codehaus.mojo.taglist.beans
- package org.codehaus.mojo.taglist.beans
R
ReportGenerator
- Class in
org.codehaus.mojo.taglist
Generates the taglist report using Doxia.
ReportGenerator(TagListReport, Collection)
- Constructor for class org.codehaus.mojo.taglist.
ReportGenerator
Constructor.
S
scanFile(File)
- Method in class org.codehaus.mojo.taglist.
FileAnalyser
Scans a file to look for task tags.
setTestXrefLocation(String)
- Method in class org.codehaus.mojo.taglist.
ReportGenerator
Set the test code cross reference location.
setXrefLocation(String)
- Method in class org.codehaus.mojo.taglist.
ReportGenerator
Set the source code cross reference location.
T
TagListReport
- Class in
org.codehaus.mojo.taglist
Scans the source files for tags and generates a report on their occurrences.
TagListReport()
- Constructor for class org.codehaus.mojo.taglist.
TagListReport
TagReport
- Class in
org.codehaus.mojo.taglist.beans
Report of the scan for a specific tag
TagReport(String)
- Constructor for class org.codehaus.mojo.taglist.beans.
TagReport
Constructor.
A
C
E
F
G
I
O
R
S
T
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
Copyright © 2005-2009. All Rights Reserved.