|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.template.TemplateTagHandler
xdoclet.XDocletTagSupport
xdoclet.modules.doc.AntdocTagsHandler
public class AntdocTagsHandler
This tag handler is used to generate Ant documentation
Field Summary | |
---|---|
protected AntdocSubTask.Element |
docElement
The element being documented |
protected AntdocSubTask.SubElement |
subElement
Current parent or child element |
Fields inherited from class xdoclet.XDocletTagSupport |
---|
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER |
Constructor Summary | |
---|---|
AntdocTagsHandler()
|
Method Summary | |
---|---|
java.lang.String |
elementName()
The name of the current element. |
java.lang.String |
enumerateValues()
List the possible values for the current method. |
void |
forAllSubElements(java.lang.String template)
Generate the tag's body for each of the current element's sub-elements. |
void |
ifHasSubElements(java.lang.String template)
Generate the tag's body if the current element has any sub-elements. |
java.lang.String |
required()
The Required status (i.e. |
java.lang.String |
rootlink()
Links to the root folder. |
void |
setDocElement(AntdocSubTask.Element antElement)
|
java.lang.String |
subElementDescription()
The description of the current sub-element. |
java.lang.String |
subElementLink()
Links to the documentation page of a nested sub-element. |
java.lang.String |
subElementName()
The name of the current sub-element. |
Methods inherited from class xdoclet.template.TemplateTagHandler |
---|
getXJavaDoc, setXJavaDoc |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected AntdocSubTask.Element docElement
protected AntdocSubTask.SubElement subElement
Constructor Detail |
---|
public AntdocTagsHandler()
Method Detail |
---|
public void setDocElement(AntdocSubTask.Element antElement)
public java.lang.String subElementName() throws XDocletException
XDocletException
public java.lang.String elementName() throws XDocletException
XDocletException
public void ifHasSubElements(java.lang.String template) throws XDocletException
template
- The body of the block tag
XDocletException
public void forAllSubElements(java.lang.String template) throws XDocletException
template
- The body of the block tag
XDocletException
public java.lang.String subElementDescription()
public java.lang.String required()
public java.lang.String rootlink()
public java.lang.String subElementLink()
public java.lang.String enumerateValues() throws XDocletException
EnumeratedAttribute
.
XDocletException
|
http://xdoclet.sourceforge.net/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |