xdoclet.modules.doc

Class AntdocTagsHandler


public class AntdocTagsHandler
extends xdoclet.XDocletTagSupport

This tag handler is used to generate Ant documentation
Version:
$Revision: 1.10 $
Author:
Aslak Hellesoy
xdoclet.taghandler
namespace = "Antdoc"
created
13. juni 2002

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

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.
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.

Methods inherited from class xdoclet.XDocletTagSupport

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

Methods inherited from class xdoclet.template.TemplateTagHandler

getXJavaDoc, setXJavaDoc

Field Details

docElement

protected AntdocSubTask.Element docElement
The element being documented

subElement

protected AntdocSubTask.SubElement subElement
Current parent or child element

Method Details

elementName

public String elementName()
            throws xdoclet.XDocletException
The name of the current element.
Returns:
name
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"

enumerateValues

public String enumerateValues()
            throws xdoclet.XDocletException
List the possible values for the current method. The property must be an Ant EnumeratedAttribute.
Returns:
Comma-separated list of values
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"

forAllSubElements

public void forAllSubElements(String template)
            throws xdoclet.XDocletException
Generate the tag's body for each of the current element's sub-elements.
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
doc.tag
type = "block"

ifHasSubElements

public void ifHasSubElements(String template)
            throws xdoclet.XDocletException
Generate the tag's body if the current element has any sub-elements.
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException -
doc.tag
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
doc.tag
type = "content"

rootlink

public String rootlink()
Links to the root folder. Only required to generate links to CSS.
Returns:
link
doc.tag
type = "content"
To do:
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.
Returns:
description
doc.tag
type = "content"

subElementLink

public String subElementLink()
Links to the documentation page of a nested sub-element.
Returns:
link
doc.tag
type = "content"

subElementName

public String subElementName()
            throws xdoclet.XDocletException
The name of the current sub-element.
Returns:
name
Throws:
xdoclet.XDocletException -
doc.tag
type = "content"