xdoclet.modules.doc

Class DocumentationTagsHandler


public class DocumentationTagsHandler
extends xdoclet.XDocletTagSupport

Version:
$Revision: 1.6 $
Author:
Ara Abrahamian (ara_e@email.com)
xdoclet.taghandler
namespace = "Doc"
created
Nov 30, 2001

Field Summary

Fields inherited from class xdoclet.XDocletTagSupport

FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER

Method Summary

String
currentNamespace()
Returns current namespace.
String
currentNamespaceTagsHandlerClassName()
Returns current namespace tags handler class name.
String
currentNamespaceTagsHandlerClassNameAsDirStructure()
Returns current namespace name.
void
forAllNamespaces(String template)
Iterates over all template namespaces registered in /tagmappings.properties file and evaluates the body of the tag for each namespace.
String
namespace()
Returns current namespace name.
String
namespaceFromClassName()
Returns current namespace name from current class name.
String
namespaceTagsHandlerClassName()
Returns current namespace tags handler class name.

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

Method Details

currentNamespace

public String currentNamespace()
            throws xdoclet.XDocletException
Returns current namespace. Used for tags_toc.xdt.
Returns:
Current namespace tags handler class name
Throws:
xdoclet.XDocletException - Description of Exception
doc.tag
type = "content"

currentNamespaceTagsHandlerClassName

public String currentNamespaceTagsHandlerClassName()
            throws xdoclet.XDocletException
Returns current namespace tags handler class name. Used for .html files.
Returns:
Current namespace name
Throws:
xdoclet.XDocletException - Description of Exception
doc.tag
type = "content"
doc.param
name = "namespace" optional = "false" description = "The namespace name we lookup the handler."

currentNamespaceTagsHandlerClassNameAsDirStructure

public String currentNamespaceTagsHandlerClassNameAsDirStructure()
            throws xdoclet.XDocletException
Returns current namespace name. Use inside forAllNamespaces only.
Returns:
Current namespace name
Throws:
xdoclet.XDocletException - Description of Exception
doc.tag
type = "content"
doc.param
name = "namespace" optional = "false" description = "The namespace name we lookup the handler."

forAllNamespaces

public void forAllNamespaces(String template)
            throws xdoclet.XDocletException
Iterates over all template namespaces registered in /tagmappings.properties file and evaluates the body of the tag for each namespace.
Parameters:
template - The body of the block tag
Throws:
xdoclet.XDocletException - Description of Exception
doc.tag
type = "block"

namespace

public String namespace()
            throws xdoclet.XDocletException
Returns current namespace name. Use inside forAllNamespaces only.
Returns:
Current namespace name
Throws:
xdoclet.XDocletException - Description of Exception
doc.tag
type = "content"

namespaceFromClassName

public String namespaceFromClassName()
            throws xdoclet.XDocletException
Returns current namespace name from current class name.
Returns:
Current namespace tags handler class name
Throws:
xdoclet.XDocletException - Description of Exception
doc.tag
type = "content"

namespaceTagsHandlerClassName

public String namespaceTagsHandlerClassName()
            throws xdoclet.XDocletException
Returns current namespace tags handler class name. Use inside forAllNamespaces only.
Returns:
Current namespace tags handler class name
Throws:
xdoclet.XDocletException - Description of Exception
doc.tag
type = "content"