xdoclet.modules.doc
Class DocumentationTagsHandler
java.lang.Object
xdoclet.template.TemplateTagHandler
xdoclet.XDocletTagSupport
xdoclet.modules.doc.DocumentationTagsHandler
public class DocumentationTagsHandler
extends xdoclet.XDocletTagSupport
- Ara Abrahamian (ara_e@email.com)
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 |
currentNamespace
public String currentNamespace()
throws xdoclet.XDocletException
Returns current namespace. Used for tags_toc.xdt.
- Current namespace tags handler class name
xdoclet.XDocletException
- Description of Exception
currentNamespaceTagsHandlerClassName
public String currentNamespaceTagsHandlerClassName()
throws xdoclet.XDocletException
Returns current namespace tags handler class name. Used for .html files.
xdoclet.XDocletException
- Description of Exception
- 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.
xdoclet.XDocletException
- Description of Exception
- 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.
template
- The body of the block tag
xdoclet.XDocletException
- Description of Exception
namespace
public String namespace()
throws xdoclet.XDocletException
Returns current namespace name. Use inside forAllNamespaces only.
xdoclet.XDocletException
- Description of Exception
namespaceFromClassName
public String namespaceFromClassName()
throws xdoclet.XDocletException
Returns current namespace name from current class name.
- Current namespace tags handler class name
xdoclet.XDocletException
- Description of Exception
namespaceTagsHandlerClassName
public String namespaceTagsHandlerClassName()
throws xdoclet.XDocletException
Returns current namespace tags handler class name. Use inside forAllNamespaces only.
- Current namespace tags handler class name
xdoclet.XDocletException
- Description of Exception