|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjodd.taglet.ToDoTaglet
A sample ToDo Taglet. This tag can be used in any kind of Doc
. It is not an inline tag. Every generated html text
element has its own CSS "todo" class.
Constructor Summary | |
ToDoTaglet()
|
Method Summary | |
java.lang.String |
getName()
Return the name of this custom tag. |
boolean |
inConstructor()
Will return true since @2do can be used in constructor
documentation. |
boolean |
inField()
Will return true since @2do can be used in field
documentation. |
boolean |
inMethod()
Will return true since @2do can be used in method
documentation. |
boolean |
inOverview()
Will return true since @2do can be used in method
documentation. |
boolean |
inPackage()
Will return true since @2do can be used in package
documentation. |
boolean |
inType()
Will return true since @2do can be used in type
documentation (classes or interfaces). |
boolean |
isInlineTag()
Will return false since @2do is not an inline tag. |
static void |
register(java.util.Map tagletMap)
Register this Taglet. |
java.lang.String |
toString(com.sun.javadoc.Tag tag)
Given the Tag representation of this custom tag, return its
string representation. |
java.lang.String |
toString(com.sun.javadoc.Tag[] tags)
Given an array of Tag s representing this custom tag, return
its string representation. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ToDoTaglet()
Method Detail |
public java.lang.String getName()
getName
in interface com.sun.tools.doclets.Taglet
public boolean inField()
@2do
can be used in field
documentation.
inField
in interface com.sun.tools.doclets.Taglet
@2do
can be used in field documentation and false
otherwise.public boolean inConstructor()
@2do
can be used in constructor
documentation.
inConstructor
in interface com.sun.tools.doclets.Taglet
@2do
can be used in constructor documentation and
false otherwise.public boolean inMethod()
@2do
can be used in method
documentation.
inMethod
in interface com.sun.tools.doclets.Taglet
@2do
can be used in method documentation and
false otherwise.public boolean inOverview()
@2do
can be used in method
documentation.
inOverview
in interface com.sun.tools.doclets.Taglet
@2do
can be used in overview documentation and
false otherwise.public boolean inPackage()
@2do
can be used in package
documentation.
inPackage
in interface com.sun.tools.doclets.Taglet
@2do
can be used in package documentation and
false otherwise.public boolean inType()
@2do
can be used in type
documentation (classes or interfaces).
inType
in interface com.sun.tools.doclets.Taglet
@2do
can be used in type documentation and false
otherwise.public boolean isInlineTag()
@2do
is not an inline tag.
isInlineTag
in interface com.sun.tools.doclets.Taglet
@2do
is not an inline tag.public static void register(java.util.Map tagletMap)
tagletMap
- the map to register this tag to.public java.lang.String toString(com.sun.javadoc.Tag tag)
Tag
representation of this custom tag, return its
string representation.
toString
in interface com.sun.tools.doclets.Taglet
tag
- the Tag
representation of this custom tag.public java.lang.String toString(com.sun.javadoc.Tag[] tags)
Tag
s representing this custom tag, return
its string representation.
toString
in interface com.sun.tools.doclets.Taglet
tags
- the array of Tag
s representing of this custom tag.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |