xdoclet.doc
Class DocumentTagsSubTask

java.lang.Object
  |
  +--xdoclet.DocletSupport
        |
        +--xdoclet.SubTask
              |
              +--xdoclet.TemplateSubTask
                    |
                    +--xdoclet.doc.DocumentTagsSubTask

All Implemented Interfaces:

java.io.Serializable

public class DocumentTagsSubTask

extends TemplateSubTask

Extracts doc:blabla tags from xdoclet.* sources and generates an html file describing the tags and their parameters.

Version:

$Revision: 1.13 $

Author:

Ara Abrahamian (ara_e@email.com)

See Also:

Serialized Form

Inner Class Summary

static class

DocumentTagsSubTask.Namespace

Inner classes inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes

Field Summary

static java.lang.String

SUBTASK_NAME

Fields inherited from class xdoclet.DocletSupport

currentTag

Constructor Summary

DocumentTagsSubTask()

Method Summary

protected void	engineStarted()
void	execute() Called to start execution of the sub-task.
protected void	generateForClass(com.sun.javadoc.ClassDoc clazz) Processed template for clazz and generates output file for clazz.
DocumentTagsSubTask.Namespace	getCurrentNamespace()
protected java.lang.String	getGeneratedFileName(com.sun.javadoc.ClassDoc clazz) Returns class name for the generated file.
java.util.ArrayList	getNamespaces()
java.lang.String	getSubTaskName()
java.util.Properties	getTagMappings()

Methods inherited from class xdoclet.TemplateSubTask

addPackageSubstitution, beanFile, copyAttributesFrom, engineFinished, getDestinationFile, getEngine, getExtent, getHavingClassTag, getOfType, getPackageSubstitutions, getParser, getSubTaskClassName, getTemplateURL, init, isGuessGenerationNeeded, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, matchesGenerationRules, setDestinationFile, setEngine, setExtent, setExtentValue, setGuessGenerationNeeded, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setParser, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess, validateOptions

Methods inherited from class xdoclet.SubTask

addConfigParam, getConfigParams, getContext, getDestDir, getMergeDir, setDestDir, setMergeDir, setSubTaskName

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUBTASK_NAME

public static final java.lang.String SUBTASK_NAME

Constructor Detail

DocumentTagsSubTask

public DocumentTagsSubTask()

Method Detail

getSubTaskName

public java.lang.String getSubTaskName()

Overrides:

getSubTaskName in class TemplateSubTask

getCurrentNamespace

public DocumentTagsSubTask.Namespace getCurrentNamespace()

getNamespaces

public java.util.ArrayList getNamespaces()

getTagMappings

public java.util.Properties getTagMappings()

execute

public void execute()
             throws XDocletException

Description copied from class: SubTask

Called to start execution of the sub-task.

Overrides:

execute in class TemplateSubTask

Following copied from class: xdoclet.SubTask

Throws:

XDocletException - Description of Exception

getGeneratedFileName

protected java.lang.String getGeneratedFileName(com.sun.javadoc.ClassDoc clazz)
                                         throws XDocletException

Description copied from class: TemplateSubTask

Returns class name for the generated file. {0} substituted by class name.

Overrides:

getGeneratedFileName in class TemplateSubTask

Following copied from class: xdoclet.TemplateSubTask

Parameters:

clazz - Description of Parameter

Returns:

The GeneratedClassName value

Throws:

XDocletException - Description of Exception

generateForClass

protected void generateForClass(com.sun.javadoc.ClassDoc clazz)
                         throws XDocletException

Processed template for clazz and generates output file for clazz.

Overrides:

generateForClass in class TemplateSubTask

Parameters:

clazz - Description of Parameter

Throws:

XDocletException - Description of Exception

engineStarted

protected void engineStarted()
                      throws XDocletException

Overrides:

engineStarted in class TemplateSubTask