|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.DocletSupport
xdoclet.SubTask
xdoclet.TemplateSubTask
xdoclet.modules.doc.AntdocSubTask
public class AntdocSubTask
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.
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 java.util.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 |
Constructor Summary | |
---|---|
AntdocSubTask()
|
Method Summary | |
---|---|
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. |
Methods inherited from class xdoclet.SubTask |
---|
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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.
Constructor Detail |
---|
public AntdocSubTask()
Method Detail |
---|
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 Parameter
XDocletException
- Description of Exceptionprotected boolean matchesGenerationRules(xjavadoc.XClass clazz) throws XDocletException
TemplateSubTask
matchesGenerationRules
in class TemplateSubTask
clazz
- Description of Parameter
XDocletException
- Description of Exception
|
http://xdoclet.sourceforge.net/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |