xdoclet.modules.doc

Class AntdocTagsHandler

public class AntdocTagsHandler extends XDocletTagSupport

This tag handler is used to generate Ant documentation

Version: $Revision: 1.10 $

Author: Aslak Hellesoy

UNKNOWN: 13. juni 2002 namespace = "Antdoc"

Field Summary
protected AntdocSubTask.ElementdocElement
The element being documented
protected AntdocSubTask.SubElementsubElement
Current parent or child element
Method Summary
StringelementName()
The name of the current element.
StringenumerateValues()
List the possible values for the current method.
voidforAllSubElements(String template)
Generate the tag's body for each of the current element's sub-elements.
voidifHasSubElements(String template)
Generate the tag's body if the current element has any sub-elements.
Stringrequired()
The Required status (i.e. is it mandatory or optional) of an attribute.
Stringrootlink()
Links to the root folder.
voidsetDocElement(AntdocSubTask.Element antElement)
StringsubElementDescription()
The description of the current sub-element.
StringsubElementLink()
Links to the documentation page of a nested sub-element.
StringsubElementName()
The name of the current sub-element.

Field Detail

docElement

protected AntdocSubTask.Element docElement
The element being documented

subElement

protected AntdocSubTask.SubElement subElement
Current parent or child element

Method Detail

elementName

public String elementName()
The name of the current element.

Returns: name

Throws: XDocletException

UNKNOWN: type = "content"

enumerateValues

public String enumerateValues()
List the possible values for the current method. The property must be an Ant EnumeratedAttribute.

Returns: Comma-separated list of values

Throws: XDocletException

UNKNOWN: type = "content"

forAllSubElements

public void forAllSubElements(String template)
Generate the tag's body for each of the current element's sub-elements.

Parameters: template The body of the block tag

Throws: XDocletException

UNKNOWN: type = "block"

ifHasSubElements

public void ifHasSubElements(String template)
Generate the tag's body if the current element has any sub-elements.

Parameters: template The body of the block tag

Throws: XDocletException

UNKNOWN: type = "block"

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.

Returns: required

UNKNOWN: type = "content"

rootlink

public String rootlink()
Links to the root folder. Only required to generate links to CSS.

Returns: link

UNKNOWN: refactor this. It's copied more or less from InfoTagsHandler type = "content"

setDocElement

public void setDocElement(AntdocSubTask.Element antElement)

subElementDescription

public String subElementDescription()
The description of the current sub-element.

Returns: description

UNKNOWN: type = "content"

subElementLink

public String subElementLink()
Links to the documentation page of a nested sub-element.

Returns: link

UNKNOWN: type = "content"

subElementName

public String subElementName()
The name of the current sub-element.

Returns: name

Throws: XDocletException

UNKNOWN: type = "content"