xdoclet.modules.doc.info

Class InfoSubTask

Implemented Interfaces:
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.
Version:
$Revision: 1.14 $
Author:
Aslak Hellesxy
ant.element
display-name = "Info/Todo" name = "info" parent = "xdoclet.modules.doc.DocumentDocletTask"
created
September 18, 2001
To do:
use DocletTask as parent instead. should be enough.

Nested Class Summary

Nested classes/interfaces inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes, TemplateSubTask.OfType

Field Summary

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

InfoSubTask()

Method Summary

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

Methods inherited from class xdoclet.TemplateSubTask

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

Methods inherited from class xdoclet.SubTask

addConfigParam, copyAttributesFrom, execute, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, init, setDestDir, setMergeDir, setSubTaskName, validateOptions

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage

Constructor Details

InfoSubTask

public InfoSubTask()
To do:
blabla (this is yet another test)

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Describe what the method does
Overrides:
engineStarted in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException - Describe the exception

execute

public void execute()
            throws xdoclet.XDocletException
Overrides:
execute in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException - Description of Exception
To do:
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
Returns:
The Header value

getProjectname

public String getProjectname()
Gets the Projectname attribute of the InfoSubTask object
Returns:
The Projectname value

getProperties

protected Properties getProperties()
Gets the Properties attribute of the InfoSubTask object
Returns:
The Properties value

setHeader

public void setHeader(String header)
Sets the Header attribute of the InfoSubTask object
Parameters:
header - The new Header value

setProjectname

public void setProjectname(String projectname)
Sets the Projectname attribute of the InfoSubTask object
Parameters:
projectname - The new Projectname value

setTag

public void setTag(String tag)
Sets the Tag attribute of the InfoSubTask object
Parameters:
tag - The new Tag value

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
validate options - noop here
Overrides:
validateOptions in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException -