xdoclet.modules.doc
Class DocumentTagsSubTask
java.lang.Objectxdoclet.DocletSupportxdoclet.SubTaskxdoclet.TemplateSubTaskxdoclet.modules.doc.DocumentTagsSubTask
- 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.
- Ara Abrahamian (ara_e@email.com)
- display-name = "Tag documentation"
name = "documenttags"
parent = "xdoclet.modules.doc.DocumentDocletTask"
- use DocletTask as parent instead. should be enough.
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
|
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 |
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 Describe what the method does
- execute in interface xdoclet.TemplateSubTask
xdoclet.XDocletException - Describe the exception
generateForClass
protected void generateForClass(XClass clazz)
throws xdoclet.XDocletException Processed template for clazz and generates output file for clazz.
- generateForClass in interface xdoclet.TemplateSubTask
clazz - Description of Parameter
xdoclet.XDocletException - Description of Exception
getCurrentNamespace
public String getCurrentNamespace()
Gets the CurrentNamespace attribute of the DocumentTagsSubTask object
- The CurrentNamespace value
getGeneratedFileName
protected String getGeneratedFileName(XClass clazz)
throws xdoclet.XDocletException Gets the GeneratedFileName attribute of the DocumentTagsSubTask object
- getGeneratedFileName in interface xdoclet.TemplateSubTask
clazz - Describe what the parameter does
- The GeneratedFileName value
xdoclet.XDocletException - Describe the exception
validateOptions
public void validateOptions()
throws xdoclet.XDocletException Called to validate configuration parameters - really noop here
- validateOptions in interface xdoclet.TemplateSubTask
xdoclet.XDocletException - thrown on failure