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.Element	docElement The element being documented
protected AntdocSubTask.SubElement	subElement Current parent or child element

Method Summary
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. is it mandatory or optional) of an attribute.
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.

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"

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"