xdoclet.modules.doc

Class DocumentTagsSubTask

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)

UNKNOWN: June 19, 2001 display-name = "Tag documentation" name = "documenttags" parent = "xdoclet.modules.doc.DocumentDocletTask" use DocletTask as parent instead. should be enough.

Method Summary
protected voidengineStarted()
Describe what the method does
voidexecute()
Describe what the method does
protected voidgenerateForClass(XClass clazz)
Processed template for clazz and generates output file for clazz.
StringgetCurrentNamespace()
Gets the CurrentNamespace attribute of the DocumentTagsSubTask object
protected StringgetGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the DocumentTagsSubTask object
voidvalidateOptions()
Called to validate configuration parameters - really noop here

Method Detail

engineStarted

protected void engineStarted()
Describe what the method does

Throws: XDocletException Describe the exception

execute

public void execute()
Describe what the method does

Throws: XDocletException Describe the exception

generateForClass

protected void generateForClass(XClass clazz)
Processed template for clazz and generates output file for clazz.

Parameters: clazz Description of Parameter

Throws: XDocletException Description of Exception

getCurrentNamespace

public String getCurrentNamespace()
Gets the CurrentNamespace attribute of the DocumentTagsSubTask object

Returns: The CurrentNamespace value

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
Gets the GeneratedFileName attribute of the DocumentTagsSubTask object

Parameters: clazz Describe what the parameter does

Returns: The GeneratedFileName value

Throws: XDocletException Describe the exception

validateOptions

public void validateOptions()
Called to validate configuration parameters - really noop here

Throws: XDocletException thrown on failure