xdoclet.modules.doc.info
Class InfoSubTask
java.lang.Object
xdoclet.DocletSupport
xdoclet.SubTask
xdoclet.TemplateSubTask
xdoclet.modules.doc.info.InfoSubTask
- Serializable
public class InfoSubTask
extends xdoclet.TemplateSubTask
Extracts tag values from classes and method docs and generates an HTML report that summarizes all occurrences of this
tag in a source tree. This task can be used to generate TODO lists or any list with metrics about the occurrence of a
certain tag.
- display-name = "Info/Todo"
name = "info"
parent = "xdoclet.modules.doc.DocumentDocletTask"
- use DocletTask as parent instead. should be enough.
protected void | engineStarted() - Describe what the method does
|
void | execute()
|
String | getHeader() - Gets the Header attribute of the InfoSubTask object
|
String | getProjectname() - Gets the Projectname attribute of the InfoSubTask object
|
protected Properties | getProperties() - Gets the Properties attribute of the InfoSubTask object
|
void | setHeader(String header) - Sets the Header attribute of the InfoSubTask object
|
void | setProjectname(String projectname) - Sets the Projectname attribute of the InfoSubTask object
|
void | setTag(String tag) - Sets the Tag attribute of the InfoSubTask object
|
void | validateOptions() - validate options - noop here
|
addOfType , addOfType , addPackageSubstitution , copyAttributesFrom , engineFinished , engineStarted , execute , generateForClass , getAcceptAbstractClasses , getAcceptInterfaces , getDestinationFile , getEngine , getExtent , getGeneratedFileName , getGenerationManager , getHavingClassTag , getOfType , getPackageSubstitutions , getSubTaskClassName , getTemplateURL , init , isPackageSubstitutionInheritanceSupported , isPrefixWithPackageStructure , javaFile , matchesGenerationRules , processInnerClasses , setAcceptAbstractClasses , setAcceptInterfaces , setDestinationFile , setEngine , setExtent , setExtentValue , setGenerationManager , setHavingClassTag , setOfType , setPackageSubstitutionInheritanceSupported , setPackageSubstitutions , setPrefixWithPackageStructure , setSubTaskClassName , setTemplateFile , setTemplateURL , startEngine , startProcess , startProcessForAll , startProcessPerClass , validateOptions |
addConfigParam , copyAttributesFrom , execute , getConfigParams , getConfigParamsAsMap , getContext , getDestDir , getMergeDir , getSubTaskName , getXJavaDoc , init , setDestDir , setMergeDir , setSubTaskName , validateOptions |
getCurrentClass , getCurrentClassTag , getCurrentConstructor , getCurrentField , getCurrentFieldTag , getCurrentMethod , getCurrentMethodTag , getCurrentPackage , getCurrentTag , isDocletGenerated , popCurrentClass , pushCurrentClass , setCurrentClass , setCurrentClassTag , setCurrentConstructor , setCurrentField , setCurrentFieldTag , setCurrentMethod , setCurrentMethodTag , setCurrentPackage |
InfoSubTask
public InfoSubTask()
- blabla (this is yet another test)
engineStarted
protected void engineStarted()
throws xdoclet.XDocletException
Describe what the method does
- engineStarted in interface xdoclet.TemplateSubTask
xdoclet.XDocletException
- Describe the exception
execute
public void execute()
throws xdoclet.XDocletException
- execute in interface xdoclet.TemplateSubTask
xdoclet.XDocletException
- Description of Exception
- generate an overview summary html too? (the default right page). It could be the old
todo file, a bit modified.
getHeader
public String getHeader()
Gets the Header attribute of the InfoSubTask object
getProjectname
public String getProjectname()
Gets the Projectname attribute of the InfoSubTask object
getProperties
protected Properties getProperties()
Gets the Properties attribute of the InfoSubTask object
setHeader
public void setHeader(String header)
Sets the Header attribute of the InfoSubTask object
header
- The new Header value
setProjectname
public void setProjectname(String projectname)
Sets the Projectname attribute of the InfoSubTask object
projectname
- The new Projectname value
setTag
public void setTag(String tag)
Sets the Tag attribute of the InfoSubTask object
validateOptions
public void validateOptions()
throws xdoclet.XDocletException
validate options - noop here
- validateOptions in interface xdoclet.TemplateSubTask
xdoclet.XDocletException
-