xdoclet.modules.doc
public class AntdocSubTask extends TemplateSubTask
Modifier and Type | Class and Description |
---|---|
class |
AntdocSubTask.Element
This class corresponds to an XML element in an Ant build file.
|
class |
AntdocSubTask.SubElement |
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType
Modifier and Type | Field and Description |
---|---|
protected java.util.Map |
classToAntElementMap
Usually, one class corresponds to only one XML element, but in some rare cases it might correspond to more.
|
currentClassTag, currentFieldTag, currentMethodTag
Constructor and Description |
---|
AntdocSubTask() |
Modifier and Type | Method and Description |
---|---|
protected void |
generateForClass(xjavadoc.XClass clazz)
Processed template for clazz and generates output file for clazz.
|
java.lang.String |
getDestinationFile()
Gets the DestinationFile attribute of the TemplateSubTask object
|
void |
init(xjavadoc.XJavaDoc xJavaDoc)
Describe what the method does
|
protected boolean |
matchesGenerationRules(xjavadoc.XClass clazz)
Returns true if output not already generated for clazz, and is of the specified type and has the specified class
tag; false otherwise.
|
protected boolean |
processInnerClasses()
Subclasses should override this method and return true if they want startProcessPerClass() to process inner
classes too.
|
void |
validateOptions()
Called to validate configuration parameters.
|
addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, engineStarted, execute, getAcceptAbstractClasses, getAcceptInterfaces, getEngine, getExtent, getGeneratedFileName, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, 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
protected final java.util.Map classToAntElementMap
Gee createFoo()
, Gee createBar()
The Gee class corresponds to <foo> AND <bar>. This map's values are Sets containing AntElements.
public java.lang.String getDestinationFile()
TemplateSubTask
getDestinationFile
in class TemplateSubTask
public void init(xjavadoc.XJavaDoc xJavaDoc) throws XDocletException
TemplateSubTask
init
in class TemplateSubTask
XDocletException
- Describe the exceptionSubTask.execute()
public void validateOptions() throws XDocletException
TemplateSubTask
validateOptions
in class TemplateSubTask
XDocletException
- Description of Exceptionprotected boolean processInnerClasses()
TemplateSubTask
processInnerClasses
in class TemplateSubTask
protected void generateForClass(xjavadoc.XClass clazz) throws XDocletException
TemplateSubTask
generateForClass
in class TemplateSubTask
clazz
- Description of ParameterXDocletException
- Description of Exceptionprotected boolean matchesGenerationRules(xjavadoc.XClass clazz) throws XDocletException
TemplateSubTask
matchesGenerationRules
in class TemplateSubTask
clazz
- Description of ParameterXDocletException
- Description of Exception