|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.codehaus.mojo.taglist.TagListReport
public class TagListReport
Scans the source files for tags and generates a report on their occurrences.
Field Summary |
---|
Fields inherited from interface org.apache.maven.reporting.MavenReport |
---|
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE |
Fields inherited from interface org.apache.maven.plugin.Mojo |
---|
ROLE |
Constructor Summary | |
---|---|
TagListReport()
|
Method Summary | |
---|---|
boolean |
canGenerateReport()
Cf. |
java.util.List |
constructSourceDirs()
Construct the list of source directories to analyse. |
protected void |
executeReport(java.util.Locale locale)
Cf. |
java.util.ResourceBundle |
getBundle()
Returns the correct resource bundle according to the locale. |
java.lang.String |
getDescription(java.util.Locale locale)
Cf. |
java.lang.String |
getName(java.util.Locale locale)
Cf. |
protected java.lang.String |
getOutputDirectory()
Cf. |
java.lang.String |
getOutputName()
Cf. |
org.apache.maven.project.MavenProject |
getProject()
Cf. |
protected org.apache.maven.doxia.siterenderer.Renderer |
getSiteRenderer()
Cf. |
java.lang.String[] |
getTags()
Returns the tags to look for. |
boolean |
isEmptyComments()
Tells whether to look for tags without comments. |
boolean |
isMultipleLineComments()
Tells whether to look for comments over multiple lines. |
boolean |
isShowEmptyDetails()
Tells whether to generate details for tags with zero occurrences. |
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport |
---|
closeReport, execute, generate, generate, generate, getCategoryName, getReportOutputDirectory, getSink, getSinkFactory, isExternalReport, setReportOutputDirectory |
Methods inherited from class org.apache.maven.plugin.AbstractMojo |
---|
getLog, getPluginContext, setLog, setPluginContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TagListReport()
Method Detail |
---|
protected void executeReport(java.util.Locale locale) throws org.apache.maven.reporting.MavenReportException
executeReport
in class org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.reporting.MavenReportException
AbstractMavenReport.executeReport(java.util.Locale)
public boolean canGenerateReport()
canGenerateReport
in interface org.apache.maven.reporting.MavenReport
canGenerateReport
in class org.apache.maven.reporting.AbstractMavenReport
MavenReport.canGenerateReport()
public java.util.List constructSourceDirs()
public java.lang.String[] getTags()
public boolean isMultipleLineComments()
public boolean isEmptyComments()
public boolean isShowEmptyDetails()
protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()
getSiteRenderer
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getSiteRenderer()
protected java.lang.String getOutputDirectory()
getOutputDirectory
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getOutputDirectory()
public org.apache.maven.project.MavenProject getProject()
getProject
in class org.apache.maven.reporting.AbstractMavenReport
AbstractMavenReport.getProject()
public java.lang.String getDescription(java.util.Locale locale)
MavenReport.getDescription(java.util.Locale)
public java.lang.String getName(java.util.Locale locale)
MavenReport.getName(java.util.Locale)
public java.lang.String getOutputName()
MavenReport.getOutputName()
public java.util.ResourceBundle getBundle()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |