Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> cantaloop >> tools >> [ doclet overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.cantaloop.tools.doclet
Class TodoTag  

java.lang.Object
  org.cantaloop.tools.doclet.AbstractExtensionTag
      org.cantaloop.tools.doclet.TodoTag

All Implemented Interfaces:

ExtensionTag

---

public class TodoTag

extends AbstractExtensionTag

A todo-tag describes some work that still needs to be accomplished. Typical examples include optimizing algorithms, proving correctness of new code, renaming fields or methods to conform to standards, cleaning up code, etc. (Taken from http://www.infospheres.caltech.edu/resources/code_standards/java_standard.html)

Example:

 \@todo <written-by value="stefan"/><priority value="mid"/>
 <assign-to value="david"/><text>There's still a lot to do.</text>
 

---

Field Summary

 

Fields inherited from class org.cantaloop.tools.doclet.AbstractExtensionTag

m_doc, m_factory, m_name, m_output, m_tag, XML_DECLARATION

 

Constructor Summary

TodoTag()

 

Method Summary
protected  void	doInnerProcessing()           Inserts a text node with the tag text as content as child node of the m_output element.

 

Methods inherited from class org.cantaloop.tools.doclet.AbstractExtensionTag

addAll, getClassLink, getClassName, getCVSClassLink, getLink, getMethodName, getOutput, getPackageName, getSourceClassLink, getTagName, isClass, isField, isMethod, process, setDoc, setTag, stringToElement, stringToElementList, toString

 

Methods inherited from class java.lang.Object

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

 

Constructor Detail

TodoTag

public TodoTag()

Method Detail

doInnerProcessing

protected void doInnerProcessing()
                          throws TagException

Description copied from class: AbstractExtensionTag

Inserts a text node with the tag text as content as child node of the m_output element. This method may be overwritten by subclasses to provide a more intelligent handling of tag content.

Overrides:

doInnerProcessing in class AbstractExtensionTag

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> cantaloop >> tools >> [ doclet overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---