xdoclet.modules.doc
Class AntdocTagsHandler

java.lang.Object
  extended by xdoclet.template.TemplateTagHandler
      extended by xdoclet.XDocletTagSupport
          extended by xdoclet.modules.doc.AntdocTagsHandler
Direct Known Subclasses:
MavenpluginTagsHandler

public class AntdocTagsHandler
extends 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
 
Constructor Summary
AntdocTagsHandler()
           
 
Method Summary
 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.
 
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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

docElement

protected AntdocSubTask.Element docElement
The element being documented


subElement

protected AntdocSubTask.SubElement subElement
Current parent or child element

Constructor Detail

AntdocTagsHandler

public AntdocTagsHandler()
Method Detail

setDocElement

public void setDocElement(AntdocSubTask.Element antElement)

subElementName

public java.lang.String subElementName()
                                throws XDocletException
The name of the current sub-element.

Returns:
name
Throws:
XDocletException
doc.tag
type = "content"

elementName

public java.lang.String elementName()
                             throws XDocletException
The name of the current element.

Returns:
name
Throws:
XDocletException
doc.tag
type = "content"

ifHasSubElements

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

Parameters:
template - The body of the block tag
Throws:
XDocletException
doc.tag
type = "block"

forAllSubElements

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

Parameters:
template - The body of the block tag
Throws:
XDocletException
doc.tag
type = "block"

subElementDescription

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

Returns:
description
doc.tag
type = "content"

required

public java.lang.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 java.lang.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

subElementLink

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

Returns:
link
doc.tag
type = "content"

enumerateValues

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

Returns:
Comma-separated list of values
Throws:
XDocletException
doc.tag
type = "content"

http://xdoclet.sourceforge.net/