xdoclet.modules.doc

Class DocumentTagsSubTask

Implemented Interfaces:
Serializable

public class DocumentTagsSubTask
extends xdoclet.TemplateSubTask

Extracts doc.blabla tags from xdoclet.* sources and generates an html file describing the tags and their parameters.
Version:
$Revision: 1.10 $
Author:
Ara Abrahamian (ara_e@email.com)
ant.element
display-name = "Tag documentation" name = "documenttags" parent = "xdoclet.modules.doc.DocumentDocletTask"
created
June 19, 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

Method Summary

protected void
engineStarted()
Describe what the method does
void
execute()
Describe what the method does
protected void
generateForClass(XClass clazz)
Processed template for clazz and generates output file for clazz.
String
getCurrentNamespace()
Gets the CurrentNamespace attribute of the DocumentTagsSubTask object
protected String
getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the DocumentTagsSubTask object
void
validateOptions()
Called to validate configuration parameters - really 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

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
Describe what the method does
Overrides:
execute in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException - Describe the exception

generateForClass

protected void generateForClass(XClass clazz)
            throws xdoclet.XDocletException
Processed template for clazz and generates output file for clazz.
Overrides:
generateForClass in interface xdoclet.TemplateSubTask
Parameters:
clazz - Description of Parameter
Throws:
xdoclet.XDocletException - Description of Exception

getCurrentNamespace

public String getCurrentNamespace()
Gets the CurrentNamespace attribute of the DocumentTagsSubTask object
Returns:
The CurrentNamespace value

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
            throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the DocumentTagsSubTask object
Overrides:
getGeneratedFileName in interface xdoclet.TemplateSubTask
Parameters:
clazz - Describe what the parameter does
Returns:
The GeneratedFileName value
Throws:
xdoclet.XDocletException - Describe the exception

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Called to validate configuration parameters - really noop here
Overrides:
validateOptions in interface xdoclet.TemplateSubTask
Throws:
xdoclet.XDocletException - thrown on failure