xdoclet.modules.doc
public class AntdocTagsHandler extends XDocletTagSupport
Modifier and Type | Field and Description |
---|---|
protected AntdocSubTask.Element |
docElement
The element being documented
|
protected AntdocSubTask.SubElement |
subElement
Current parent or child element
|
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
Constructor and Description |
---|
AntdocTagsHandler() |
Modifier and Type | Method and Description |
---|---|
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.
|
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
getXJavaDoc, setXJavaDoc
protected AntdocSubTask.Element docElement
protected AntdocSubTask.SubElement subElement
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 tagXDocletException
public void forAllSubElements(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
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