org.inria.ns.reflex.javadoc
Class WarningTaglet

java.lang.Object
  extended by org.inria.ns.reflex.javadoc.WarningTaglet
All Implemented Interfaces:
com.sun.tools.doclets.Taglet

public class WarningTaglet
extends Object
implements com.sun.tools.doclets.Taglet

WarningTaglet represents the @warning taglet.

Author:
Philippe Poulard

Constructor Summary
WarningTaglet()
           
 
Method Summary
 String getName()
          Return the name of this taglet.
 boolean inConstructor()
          Return true.
 boolean inField()
          Return true.
 boolean inMethod()
          Return true.
 boolean inOverview()
          Return true.
 boolean inPackage()
          Return true.
 boolean inType()
          Return true.
 boolean isInlineTag()
          Return true.
static void register(Map tagletMap)
          Register this taglet.
 String toString(Tag tag)
          Return a warning.
 String toString(Tag[] tags)
          Given an array of Tags representing this custom tag, return its string representation.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WarningTaglet

public WarningTaglet()
Method Detail

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 taglet.

Specified by:
getName in interface com.sun.tools.doclets.Taglet
Returns:
"warning".
See Also:
Taglet.getName()

inField

public boolean inField()
Return true.

Specified by:
inField in interface com.sun.tools.doclets.Taglet
Returns:
true.
See Also:
Taglet.inField()

inConstructor

public boolean inConstructor()
Return true.

Specified by:
inConstructor in interface com.sun.tools.doclets.Taglet
Returns:
true.
See Also:
Taglet.inConstructor()

inMethod

public boolean inMethod()
Return true.

Specified by:
inMethod in interface com.sun.tools.doclets.Taglet
Returns:
true.
See Also:
Taglet.inMethod()

inOverview

public boolean inOverview()
Return true.

Specified by:
inOverview in interface com.sun.tools.doclets.Taglet
Returns:
true.
See Also:
Taglet.inOverview()

inPackage

public boolean inPackage()
Return true.

Specified by:
inPackage in interface com.sun.tools.doclets.Taglet
Returns:
true.
See Also:
Taglet.inPackage()

inType

public boolean inType()
Return true.

Specified by:
inType in interface com.sun.tools.doclets.Taglet
Returns:
true.
See Also:
Taglet.inType()

isInlineTag

public boolean isInlineTag()
Return true.

Specified by:
isInlineTag in interface com.sun.tools.doclets.Taglet
Returns:
true.
See Also:
Taglet.isInlineTag()

toString

public String toString(Tag tag)
Return a warning.

Specified by:
toString in interface com.sun.tools.doclets.Taglet
Returns:
"<span style="color:red"> *** Text *** </span>"
See Also:
Taglet.toString(com.sun.javadoc.Tag)

toString

public String toString(Tag[] tags)
Given an array of Tags representing this custom tag, return its string representation.

Specified by:
toString in interface com.sun.tools.doclets.Taglet
Parameters:
tags - The array of Tags representing of this custom tag.