|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.objectweb.easybeans.tests.taglets.BaseTaglet
public class BaseTaglet
This is a base taglet to document tests. Example: @toto the toto is magic.
Field Summary | |
---|---|
private java.lang.String |
strName
Tag literal. |
Constructor Summary | |
---|---|
BaseTaglet(java.lang.String name)
|
Method Summary | |
---|---|
java.lang.String |
getName()
Return the name of this custom tag. |
boolean |
inConstructor()
Will return true. |
boolean |
inField()
Will return false. |
boolean |
inMethod()
Will return true. |
boolean |
inOverview()
Will return true. |
boolean |
inPackage()
Will return true. |
boolean |
inType()
Will return false. |
boolean |
isInlineTag()
Will return false. |
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 |
Field Detail |
---|
private java.lang.String strName
Constructor Detail |
---|
public BaseTaglet(java.lang.String name)
name
- tag name. Example: tag = @toto, name = toto.Method Detail |
---|
public boolean inField()
@tagName
can't be used in field documentation.
inField
in interface com.sun.tools.doclets.Taglet
@tagName
can be used in field documentation and false
otherwise.public boolean inConstructor()
@tagName
can be used in constructor documentation.
inConstructor
in interface com.sun.tools.doclets.Taglet
@tagName
can be used in constructor documentation and false
otherwise.public boolean inMethod()
@tagName
can be used in method documentation.
inMethod
in interface com.sun.tools.doclets.Taglet
@tagName
can be used in method documentation and false
otherwise.public boolean inOverview()
@tagName
can be used in overview documentation.
inOverview
in interface com.sun.tools.doclets.Taglet
@tagName
can be used in method documentation and false
otherwise.public boolean inPackage()
@tagName
can be used in package documentation.
inPackage
in interface com.sun.tools.doclets.Taglet
@tagName
can be used in method documentation and false
otherwise.public boolean inType()
@tagName
can't be used in type documentation.
inType
in interface com.sun.tools.doclets.Taglet
@tagName
can be used in type documentation and false
otherwise.public boolean isInlineTag()
@tagName
is not an inline tag.
isInlineTag
in interface com.sun.tools.doclets.Taglet
@tagName
is not an inline tag.public java.lang.String getName()
getName
in interface com.sun.tools.doclets.Taglet
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 |