xdoclet.modules.doc

Class DocumentationTagsHandler

public class DocumentationTagsHandler extends XDocletTagSupport

Version: $Revision: 1.6 $

Author: Ara Abrahamian (ara_e@email.com)

UNKNOWN: Nov 30, 2001 namespace = "Doc"

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.

Method Detail

currentNamespace

public String currentNamespace()

Returns current namespace. Used for tags_toc.xdt.

Returns: Current namespace tags handler class name

Throws: XDocletException Description of Exception

UNKNOWN: type = "content"

currentNamespaceTagsHandlerClassName

public String currentNamespaceTagsHandlerClassName()

Returns current namespace tags handler class name. Used for .html files.

Returns: Current namespace name

Throws: XDocletException Description of Exception

UNKNOWN: type = "content" name = "namespace" optional = "false" description = "The namespace name we lookup the * handler."

currentNamespaceTagsHandlerClassNameAsDirStructure

public String currentNamespaceTagsHandlerClassNameAsDirStructure()

Returns current namespace name. Use inside forAllNamespaces only.

Returns: Current namespace name

Throws: XDocletException Description of Exception

UNKNOWN: type = "content" name = "namespace" optional = "false" description = "The namespace name we lookup the * handler."

forAllNamespaces

public void forAllNamespaces(String template)

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: XDocletException Description of Exception

UNKNOWN: type = "block"

namespace

public String namespace()

Returns current namespace name. Use inside forAllNamespaces only.

Returns: Current namespace name

Throws: XDocletException Description of Exception

UNKNOWN: type = "content"

namespaceFromClassName

public String namespaceFromClassName()

Returns current namespace name from current class name.

Returns: Current namespace tags handler class name

Throws: XDocletException Description of Exception

UNKNOWN: type = "content"

namespaceTagsHandlerClassName

public String namespaceTagsHandlerClassName()

Returns current namespace tags handler class name. Use inside forAllNamespaces only.

Returns: Current namespace tags handler class name

Throws: XDocletException Description of Exception

UNKNOWN: type = "content"