xdoclet.modules.doc
Class AntdocTagsHandler
java.lang.Object
xdoclet.template.TemplateTagHandler
xdoclet.XDocletTagSupport
xdoclet.modules.doc.AntdocTagsHandler
public class AntdocTagsHandler
extends xdoclet.XDocletTagSupport
This tag handler is used to generate Ant documentation
protected AntdocSubTask.Element | docElement - The element being documented
|
protected AntdocSubTask.SubElement | subElement - Current parent or child element
|
String | elementName() - The name of the current element.
|
String | enumerateValues() - List the possible values for the current method.
|
void | forAllSubElements(String template) - Generate the tag's body for each of the current element's sub-elements.
|
void | ifHasSubElements(String template) - Generate the tag's body if the current element has any sub-elements.
|
String | required() - The Required status (i.e.
|
String | rootlink() - Links to the root folder.
|
void | setDocElement(AntdocSubTask.Element antElement)
|
String | subElementDescription() - The description of the current sub-element.
|
String | subElementLink() - Links to the documentation page of a nested sub-element.
|
String | subElementName() - The name of the current sub-element.
|
delimit , expandClassName , generate , getCurrentClass , getCurrentClassTag , getCurrentConstructor , getCurrentField , getCurrentFieldTag , getCurrentMethod , getCurrentMethodTag , getCurrentPackage , getDocletContext , getEngine , getExpandedDelimitedTagValue , getTagValue , getTagValue , getTagValue , hasHavingClassTag , hasTag , isTagValueEqual , mandatoryParamNotFound , mandatoryTemplateTagParamNotFound , modifiers , popCurrentClass , pushCurrentClass , setCurrentClass , setCurrentClassTag , setCurrentConstructor , setCurrentField , setCurrentFieldTag , setCurrentMethod , setCurrentMethodTag , setCurrentPackage |
docElement
protected AntdocSubTask.Element docElement
The element being documented
subElement
protected AntdocSubTask.SubElement subElement
Current parent or child element
elementName
public String elementName()
throws xdoclet.XDocletException
The name of the current element.
xdoclet.XDocletException
-
enumerateValues
public String enumerateValues()
throws xdoclet.XDocletException
List the possible values for the current method. The property must be an Ant EnumeratedAttribute
.
- Comma-separated list of values
xdoclet.XDocletException
-
forAllSubElements
public void forAllSubElements(String template)
throws xdoclet.XDocletException
Generate the tag's body for each of the current element's sub-elements.
template
- The body of the block tag
xdoclet.XDocletException
-
ifHasSubElements
public void ifHasSubElements(String template)
throws xdoclet.XDocletException
Generate the tag's body if the current element has any sub-elements.
template
- The body of the block tag
xdoclet.XDocletException
-
required
public String required()
The Required status (i.e. is it mandatory or optional) of an attribute. Uses the value text if it is present,
otherwise defaults to "Yes." or "No." depending on whether an \@ant.required or \@ant.not-required tag is found.
rootlink
public String rootlink()
Links to the root folder. Only required to generate links to CSS.
- refactor this. It's copied more or less from InfoTagsHandler
setDocElement
public void setDocElement(AntdocSubTask.Element antElement)
subElementDescription
public String subElementDescription()
The description of the current sub-element.
subElementLink
public String subElementLink()
Links to the documentation page of a nested sub-element.
subElementName
public String subElementName()
throws xdoclet.XDocletException
The name of the current sub-element.
xdoclet.XDocletException
-