xdoclet.modules.doc
public class DocumentTagsSubTask extends TemplateSubTask
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType
currentClassTag, currentFieldTag, currentMethodTag
Constructor and Description |
---|
DocumentTagsSubTask() |
Modifier and Type | Method and Description |
---|---|
protected void |
engineStarted()
Describe what the method does
|
void |
execute()
Describe what the method does
|
protected void |
generateForClass(xjavadoc.XClass clazz)
Processed template for clazz and generates output file for clazz.
|
java.lang.String |
getCurrentNamespace()
Gets the CurrentNamespace attribute of the DocumentTagsSubTask object
|
protected java.lang.String |
getGeneratedFileName(xjavadoc.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, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, 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
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName
getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
public java.lang.String getCurrentNamespace()
public void validateOptions() throws XDocletException
validateOptions
in class TemplateSubTask
XDocletException
- thrown on failurepublic void execute() throws XDocletException
execute
in class TemplateSubTask
XDocletException
- Describe the exceptionprotected java.lang.String getGeneratedFileName(xjavadoc.XClass clazz) throws XDocletException
getGeneratedFileName
in class TemplateSubTask
clazz
- Describe what the parameter doesXDocletException
- Describe the exceptionprotected void generateForClass(xjavadoc.XClass clazz) throws XDocletException
generateForClass
in class TemplateSubTask
clazz
- Description of ParameterXDocletException
- Description of Exceptionprotected void engineStarted() throws XDocletException
engineStarted
in class TemplateSubTask
XDocletException
- Describe the exception