|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.DocletSupport
xdoclet.SubTask
xdoclet.TemplateSubTask
xdoclet.modules.doc.info.InfoSubTask
public class InfoSubTask
Extracts tag values from classes and method docs and generates an HTML report that summarizes all occurrences of this tag in a source tree. This task can be used to generate TODO lists or any list with metrics about the occurrence of a certain tag.
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 | |
---|---|
InfoSubTask()
|
Method Summary | |
---|---|
protected void |
engineStarted()
Describe what the method does |
void |
execute()
Describe what the method does |
java.lang.String |
getHeader()
Gets the Header attribute of the InfoSubTask object |
java.lang.String |
getProjectname()
Gets the Projectname attribute of the InfoSubTask object |
protected java.util.Properties |
getProperties()
Gets the Properties attribute of the InfoSubTask object |
void |
setHeader(java.lang.String header)
Sets the Header attribute of the InfoSubTask object |
void |
setProjectname(java.lang.String projectname)
Sets the Projectname attribute of the InfoSubTask object |
void |
setTag(java.lang.String tag)
Sets the Tag attribute of the InfoSubTask object |
void |
validateOptions()
validate options - noop here |
Methods inherited from class xdoclet.SubTask |
---|
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public InfoSubTask()
Method Detail |
---|
public java.lang.String getHeader()
public java.lang.String getProjectname()
public void setHeader(java.lang.String header)
header
- The new Header valuepublic void setTag(java.lang.String tag)
tag
- The new Tag valuepublic void setProjectname(java.lang.String projectname)
projectname
- The new Projectname valuepublic void execute() throws XDocletException
TemplateSubTask
execute
in class TemplateSubTask
XDocletException
- Description of Exceptionpublic void validateOptions() throws XDocletException
validateOptions
in class TemplateSubTask
XDocletException
protected java.util.Properties getProperties()
protected void engineStarted() throws XDocletException
engineStarted
in class TemplateSubTask
XDocletException
- Describe the exception
|
http://xdoclet.sourceforge.net/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |