nesstar.javadoc
Class ToDoTaglet

java.lang.Object
  nesstar.javadoc.ATaglet
      nesstar.javadoc.ToDoTaglet

public class ToDoTaglet
extends ATaglet

A sample Taglet for @todo. This is a slightly modified version of the sample Taglet with the same name from Sun. This is not an inline tag. The text is displayed in yellow to remind the developer to perform a task. For example, "@todo Fix this!" would be shown as:

To Do:

Fix this!

Author:

Jamie Ho, Titto Assini

Constructor Summary

ToDoTaglet()

Method Summary

String	getName() Return the name of this custom tag.
boolean	isInlineTag()
static void	register(Map tagletMap) Register this Taglet.
String	toString(Tag[] tags) Given an array of Tags representing this custom tag, return its string representation.

Methods inherited from class nesstar.javadoc.ATaglet

inConstructor, inField, inMethod, inOverview, inPackage, inType, register

Methods inherited from class java.lang.Object

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

Constructor Detail

ToDoTaglet

public ToDoTaglet()

Method Detail

isInlineTag

public boolean isInlineTag()

Overrides:

isInlineTag in class ATaglet

Returns:

false since @todo is not an inline tag.

register

public static void register(Map tagletMap)

Register this Taglet.

Parameters:

tagletMap - the map to register this tag to.

getName

public String getName()

Return the name of this custom tag.

toString

public String toString(Tag[] tags)

Given an array of Tags representing this custom tag, return its string representation.

Overrides:

toString in class ATaglet

Parameters:

tags - the array of Tags representing of this custom tag.