xdoclet.modules.doc.info

Class InfoSubTask

public class InfoSubTask extends 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

UNKNOWN: September 18, 2001 display-name = "Info/Todo" name = "info" parent = "xdoclet.modules.doc.DocumentDocletTask" use DocletTask as parent instead. should be enough.

Constructor Summary
InfoSubTask()
Method Summary
protected voidengineStarted()
Describe what the method does
voidexecute()
StringgetHeader()
Gets the Header attribute of the InfoSubTask object
StringgetProjectname()
Gets the Projectname attribute of the InfoSubTask object
protected PropertiesgetProperties()
Gets the Properties attribute of the InfoSubTask object
voidsetHeader(String header)
Sets the Header attribute of the InfoSubTask object
voidsetProjectname(String projectname)
Sets the Projectname attribute of the InfoSubTask object
voidsetTag(String tag)
Sets the Tag attribute of the InfoSubTask object
voidvalidateOptions()
validate options - noop here

Constructor Detail

InfoSubTask

public InfoSubTask()

UNKNOWN: blabla (this is yet another test)

Method Detail

engineStarted

protected void engineStarted()
Describe what the method does

Throws: XDocletException Describe the exception

execute

public void execute()

Throws: XDocletException Description of Exception

UNKNOWN: 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()
validate options - noop here

Throws: XDocletException