xdoclet.doc.info
Class InfoSubTask

java.lang.Object
  |
  +--xdoclet.DocletSupport
        |
        +--xdoclet.SubTask
              |
              +--xdoclet.TemplateSubTask
                    |
                    +--xdoclet.doc.info.InfoSubTask

All Implemented Interfaces:

java.io.Serializable

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.16 $

Author:

Aslak Hellesøy

See Also:

Serialized Form

Inner classes inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes

Field Summary

static java.lang.String

SUBTASK_NAME

Fields inherited from class xdoclet.DocletSupport

currentTag

Constructor Summary

InfoSubTask(DocumentDocletTask documentDocletTask)

Method Summary

protected void	engineStarted()
void	execute() Called to start execution of the sub-task.
java.lang.String	getHeader()
java.lang.String	getProjectname()
protected java.util.Properties	getProperties()
java.lang.String	getSubTaskName()
void	setHeader(java.lang.String header)
void	setProjectname(java.lang.String projectname)
void	setTag(java.lang.String tag)

Methods inherited from class xdoclet.TemplateSubTask

addPackageSubstitution, beanFile, copyAttributesFrom, engineFinished, generateForClass, getDestinationFile, getEngine, getExtent, getGeneratedFileName, getHavingClassTag, getOfType, getPackageSubstitutions, getParser, getSubTaskClassName, getTemplateURL, init, isGuessGenerationNeeded, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, matchesGenerationRules, setDestinationFile, setEngine, setExtent, setExtentValue, setGuessGenerationNeeded, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setParser, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess, validateOptions

Methods inherited from class xdoclet.SubTask

addConfigParam, getConfigParams, getContext, getDestDir, getMergeDir, setDestDir, setMergeDir, setSubTaskName

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUBTASK_NAME

public static final java.lang.String SUBTASK_NAME

Constructor Detail

InfoSubTask

public InfoSubTask(DocumentDocletTask documentDocletTask)

Method Detail

getHeader

public java.lang.String getHeader()

getSubTaskName

public java.lang.String getSubTaskName()

Overrides:

getSubTaskName in class TemplateSubTask

getProjectname

public java.lang.String getProjectname()

setHeader

public void setHeader(java.lang.String header)

setTag

public void setTag(java.lang.String tag)

setProjectname

public void setProjectname(java.lang.String projectname)

execute

public void execute()
             throws XDocletException

Description copied from class: SubTask

Called to start execution of the sub-task.

Overrides:

execute in class TemplateSubTask

Throws:

XDocletException - Description of Exception

getProperties

protected java.util.Properties getProperties()

engineStarted

protected void engineStarted()
                      throws XDocletException

Overrides:

engineStarted in class TemplateSubTask