xdoclet.modules.doc

Class AntdocSubTask

Implemented Interfaces:
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.
Version:
$Revision: 1.17 $
Author:
Aslak Hellesxy
ant.element
display-name = "Ant documentation" name = "antdocs" parent = "xdoclet.DocletTask"
created
21. juli 2002
To do:
use DocletTask as parent instead. should be enough.

Nested Class Summary

class
AntdocSubTask.Element
This class corresponds to an XML element in an Ant build file.
class
AntdocSubTask.SubElement

Nested classes/interfaces inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes, TemplateSubTask.OfType

Field Summary

protected Map
classToAntElementMap
Usually, one class corresponds to only one XML element, but in some rare cases it might correspond to more.

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Method Summary

protected void
generateForClass(XClass clazz)
String
getDestinationFile()
void
init(XJavaDoc xJavaDoc)
protected boolean
matchesGenerationRules(XClass clazz)
protected boolean
processInnerClasses()
void
validateOptions()

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

Field Details

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.

Method Details

generateForClass

protected void generateForClass(XClass clazz)
            throws xdoclet.XDocletException
Overrides:
generateForClass in interface xdoclet.TemplateSubTask

getDestinationFile

public String getDestinationFile()
Overrides:
getDestinationFile in interface xdoclet.TemplateSubTask

init

public void init(XJavaDoc xJavaDoc)
            throws xdoclet.XDocletException
Overrides:
init in interface xdoclet.TemplateSubTask

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)
            throws xdoclet.XDocletException
Overrides:
matchesGenerationRules in interface xdoclet.TemplateSubTask

processInnerClasses

protected boolean processInnerClasses()
Overrides:
processInnerClasses in interface xdoclet.TemplateSubTask

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Overrides:
validateOptions in interface xdoclet.TemplateSubTask