org.tullmann.taglets
Class ToDo

java.lang.Object
  |
  +--org.tullmann.taglets.ListTag
        |
        +--org.tullmann.taglets.ToDo

All Implemented Interfaces:

com.sun.tools.doclets.Taglet

public class ToDo

extends ListTag

A Taglet that defines the @todo tag for Javadoc comments. The ToDo taglet is customizable and handles multiple entries cleanly. See below, for an example.

Run javadoc with a -tagletpath that points to the compiled version of this class (and its dependents) and pass -taglet org.tullmann.taglets.ToDo to javadoc. That will cause the @todo tag to be registered.

Examples: See the end of this documentation block for examples of how multiple @todo items are handled. See the ToDo constructor for an example of a single todo item tag.

See the ListTag documentation for a list of preferences that can be used to customize the output of this tag.

To Do:

• Add a 'done' tag for converting todo items into done items.

• This is a fake todo item so you can see what multiple todo items look like.

• This is another fake todo item.

Since:

January, 2002

Author:

Patrick Tullmann <taglets@tullmann.org>

Field Summary

Fields inherited from class org.tullmann.taglets.ListTag

ORDERED_LIST, TABLE_LIST, tagPrefs, UNORDERED_LIST, VISIBLETABLE_LIST

Constructor Summary

ToDo()
Create a new ListTag, with tag name 'todo'.

Method Summary

static void

register(java.util.Map tagletMap)

Methods inherited from class org.tullmann.taglets.ListTag

emitCustomFooter, emitCustomHeader, emitFooter, emitHeader, emitTag, endingTags, forceColorPrefs, forceCustomDefaultPrefs, formatText, getName, inConstructor, inField, inMethod, inOverview, inPackage, inType, isInlineTag, parseTagText, register, startingTags, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ToDo

public ToDo()

Create a new ListTag, with tag name 'todo'. Default the tag header to 'To Do:' and default to an unordered list.

To Do:

• a single todo entry

Method Detail

register

public static void register(java.util.Map tagletMap)