xdoclet.modules.doc.info

Class InfoTagsHandler


public class InfoTagsHandler
extends xdoclet.XDocletTagSupport

Version:
$Revision: 1.9 $
Author:
Aslak Hellesxy
xdoclet.taghandler
namespace = "Info"
created
Oct 15, 2001

Field Summary

Fields inherited from class xdoclet.XDocletTagSupport

FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER

Method Summary

String
classTagValue()
Describe what the method does
String
constructorTagValue()
Describe what the method does
String
fieldTagValue()
Describe what the method does
void
forAllClassTags(String template)
Describe what the method does
void
forAllConstructorTags(String template)
Describe what the method does
void
forAllFieldTags(String template)
Describe what the method does
void
forAllMethodTags(String template)
Describe what the method does
void
ifTagCountNotZero(String template, Properties properties)
Describe what the method does
String
methodTagValue()
Describe what the method does
String
projectname()
Describe what the method does
String
rootlink()
Describe what the method does
String
tagCount(Properties properties)
Describe what the method does

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

classTagValue

public String classTagValue()
            throws xdoclet.XDocletException
Describe what the method does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException - Describe the exception

constructorTagValue

public String constructorTagValue()
            throws xdoclet.XDocletException
Describe what the method does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException - Describe the exception

fieldTagValue

public String fieldTagValue()
            throws xdoclet.XDocletException
Describe what the method does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException - Describe the exception

forAllClassTags

public void forAllClassTags(String template)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
template - Describe what the parameter does
Throws:
xdoclet.XDocletException - Describe the exception

forAllConstructorTags

public void forAllConstructorTags(String template)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
template - Describe what the parameter does
Throws:
xdoclet.XDocletException - Describe the exception

forAllFieldTags

public void forAllFieldTags(String template)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
template - Describe what the parameter does
Throws:
xdoclet.XDocletException - Describe the exception

forAllMethodTags

public void forAllMethodTags(String template)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
template - Describe what the parameter does
Throws:
xdoclet.XDocletException - Describe the exception

ifTagCountNotZero

public void ifTagCountNotZero(String template,
                              Properties properties)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
template - Describe what the parameter does
properties - Describe what the parameter does
Throws:
xdoclet.XDocletException - Describe the exception

methodTagValue

public String methodTagValue()
            throws xdoclet.XDocletException
Describe what the method does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException - Describe the exception

projectname

public String projectname()
            throws xdoclet.XDocletException
Describe what the method does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException - Describe the exception

rootlink

public String rootlink()
            throws xdoclet.XDocletException
Describe what the method does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException - Describe the exception

tagCount

public String tagCount(Properties properties)
            throws xdoclet.XDocletException
Describe what the method does
Parameters:
properties - Describe what the parameter does
Returns:
Describe the return value
Throws:
xdoclet.XDocletException - Describe the exception