org.codehaus.mojo.taglist

Class TagListReport

public class TagListReport extends AbstractMavenReport

MOJO for the tag list report.

Author: Fabrice Bellingard

UNKNOWN: taglist

Method Summary
booleancanGenerateReport()
Cf. overriden method documentation.
protected voidexecuteReport(Locale locale)
Cf. overriden method documentation.
StringgetDescription(Locale locale)
Cf. overriden method documentation.
StringgetName(Locale locale)
Cf. overriden method documentation.
protected StringgetOutputDirectory()
Cf. overriden method documentation.
StringgetOutputName()
Cf. overriden method documentation.
MavenProjectgetProject()
Cf. overriden method documentation.
protected RenderergetSiteRenderer()
Cf. overriden method documentation.
String[]getTags()
Returns the tags to look for.
booleanisMultipleLineComments()
Tells whether we should look for comments over multiple lines

Method Detail

canGenerateReport

public boolean canGenerateReport()
Cf. overriden method documentation.

See Also: org.apache.maven.reporting.MavenReport#canGenerateReport()

executeReport

protected void executeReport(Locale locale)
Cf. overriden method documentation.

See Also: org.apache.maven.reporting.AbstractMavenReport#executeReport(java.util.Locale)

getDescription

public String getDescription(Locale locale)
Cf. overriden method documentation.

See Also: org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)

getName

public String getName(Locale locale)
Cf. overriden method documentation.

See Also: org.apache.maven.reporting.MavenReport#getName(java.util.Locale)

getOutputDirectory

protected String getOutputDirectory()
Cf. overriden method documentation.

See Also: org.apache.maven.reporting.AbstractMavenReport#getOutputDirectory()

getOutputName

public String getOutputName()
Cf. overriden method documentation.

See Also: org.apache.maven.reporting.MavenReport#getOutputName()

getProject

public MavenProject getProject()
Cf. overriden method documentation.

See Also: org.apache.maven.reporting.AbstractMavenReport#getProject()

getSiteRenderer

protected Renderer getSiteRenderer()
Cf. overriden method documentation.

See Also: org.apache.maven.reporting.AbstractMavenReport#getSiteRenderer()

getTags

public String[] getTags()
Returns the tags to look for.

Returns: a collection of String objects representing the tag names.

isMultipleLineComments

public boolean isMultipleLineComments()
Tells whether we should look for comments over multiple lines

Returns: Returns true if the analyser should look for multiple lines.

Copyright © 2005-2007 null. All Rights Reserved.