xdoclet.modules.doc
Class AntdocSubTask
java.lang.Object
xdoclet.DocletSupport
xdoclet.SubTask
xdoclet.TemplateSubTask
xdoclet.modules.doc.AntdocSubTask
- Serializable
public class AntdocSubTask
extends xdoclet.TemplateSubTask
Generates ant docs. Introspects classes and looks for nested elements. Generates one single file for each element.
All generated element docs also links nested elements' docs.
- display-name = "Ant documentation"
name = "antdocs"
parent = "xdoclet.DocletTask"
- use DocletTask as parent instead. should be enough.
protected Map | classToAntElementMap - Usually, one class corresponds to only one XML element, but in some rare cases it might correspond to more.
|
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 |
classToAntElementMap
protected final Map classToAntElementMap
Usually, one class corresponds to only one XML element, but in some rare cases it might correspond to more. This
is if the same class is used in e.g. several create methods:
Gee createFoo()
,
Gee createBar()
The Gee class corresponds to <foo> AND <bar>. This map's values are Sets containing AntElements.
generateForClass
protected void generateForClass(XClass clazz)
throws xdoclet.XDocletException
- generateForClass in interface xdoclet.TemplateSubTask
getDestinationFile
public String getDestinationFile()
- getDestinationFile in interface xdoclet.TemplateSubTask
init
public void init(XJavaDoc xJavaDoc)
throws xdoclet.XDocletException
- init in interface xdoclet.TemplateSubTask
matchesGenerationRules
protected boolean matchesGenerationRules(XClass clazz)
throws xdoclet.XDocletException
- matchesGenerationRules in interface xdoclet.TemplateSubTask
processInnerClasses
protected boolean processInnerClasses()
- processInnerClasses in interface xdoclet.TemplateSubTask
validateOptions
public void validateOptions()
throws xdoclet.XDocletException
- validateOptions in interface xdoclet.TemplateSubTask