xdoclet.modules.doc
Class DocumentTagsSubTask

java.lang.Object
  xdoclet.DocletSupport
      xdoclet.SubTask
          xdoclet.TemplateSubTask
              xdoclet.modules.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.10 $

Author:

Ara Abrahamian (ara_e@email.com)

See Also:

Serialized Form

ant.element

display-name = "Tag documentation" name = "documenttags" parent = "xdoclet.modules.doc.DocumentDocletTask"

created

June 19, 2001

To do:

use DocletTask as parent instead. should be enough.

Nested Class Summary

Nested classes/interfaces inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes, TemplateSubTask.OfType

Field Summary

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

DocumentTagsSubTask()

Method Summary

protected void	engineStarted() Describe what the method does
void	execute() Describe what the method does
protected void	generateForClass(xjavadoc.XClass clazz) Processed template for clazz and generates output file for clazz.
java.lang.String	getCurrentNamespace() Gets the CurrentNamespace attribute of the DocumentTagsSubTask object
protected java.lang.String	getGeneratedFileName(xjavadoc.XClass clazz) Gets the GeneratedFileName attribute of the DocumentTagsSubTask object
void	validateOptions() Called to validate configuration parameters - really noop here

Methods inherited from class xdoclet.TemplateSubTask

addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, init, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, matchesGenerationRules, processInnerClasses, setAcceptAbstractClasses, setAcceptInterfaces, setDestinationFile, setEngine, setExtent, setExtentValue, setGenerationManager, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess, startProcessForAll, startProcessPerClass

Methods inherited from class xdoclet.SubTask

addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentTagsSubTask

public DocumentTagsSubTask()

Method Detail

getCurrentNamespace

public java.lang.String getCurrentNamespace()

Gets the CurrentNamespace attribute of the DocumentTagsSubTask object

Returns:

The CurrentNamespace value

validateOptions

public void validateOptions()
                     throws XDocletException

Called to validate configuration parameters - really noop here

Overrides:

validateOptions in class TemplateSubTask

Throws:

XDocletException - thrown on failure

execute

public void execute()
             throws XDocletException

Describe what the method does

Overrides:

execute in class TemplateSubTask

Throws:

XDocletException - Describe the exception

getGeneratedFileName

protected java.lang.String getGeneratedFileName(xjavadoc.XClass clazz)
                                         throws XDocletException

Gets the GeneratedFileName attribute of the DocumentTagsSubTask object

Overrides:

getGeneratedFileName in class TemplateSubTask

Parameters:

clazz - Describe what the parameter does

Returns:

The GeneratedFileName value

Throws:

XDocletException - Describe the exception

generateForClass

protected void generateForClass(xjavadoc.XClass 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

Describe what the method does

Overrides:

engineStarted in class TemplateSubTask

Throws:

XDocletException - Describe the exception