|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.h2b.taglets.BlockTaglet
@ClassLabel(copyright="Copyright (C) 2008 Hans-Hermann Bode", ident="$Id: BlockTaglet.java,v 1.3 2008/12/14 17:05:37 h2b Exp $") public abstract class BlockTaglet
An abstract class that represents a Javadoc block taglet. It implements all
in...
methods of Taglet
so that it can be used in
documentation for all program elements.
Constructor Summary | |
---|---|
BlockTaglet()
|
Method Summary | |
---|---|
abstract java.lang.String |
getName()
Returns the name of this custom tag. |
boolean |
inConstructor()
Will return true since it can be used in constructor documentation. |
boolean |
inField()
Will return true since it can be used in field documentation. |
boolean |
inMethod()
Will return true since it can be used in method documentation. |
boolean |
inOverview()
Will return true since it can be used in overview documentation. |
boolean |
inPackage()
Will return true since it can be used in package documentation. |
boolean |
inType()
Will return true since it can be used in type documentation (classes or interfaces). |
boolean |
isInlineTag()
Will return false since it is not an inline tag. |
abstract java.lang.String |
toString(com.sun.javadoc.Tag tag)
Given the Tag representation of this custom
tag, return its string representation. |
abstract 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 BlockTaglet()
Method Detail |
---|
public abstract java.lang.String getName()
getName
in interface com.sun.tools.doclets.Taglet
public boolean inField()
inField
in interface com.sun.tools.doclets.Taglet
true
public boolean inConstructor()
inConstructor
in interface com.sun.tools.doclets.Taglet
true
public boolean inMethod()
inMethod
in interface com.sun.tools.doclets.Taglet
true
public boolean inOverview()
inOverview
in interface com.sun.tools.doclets.Taglet
true
public boolean inPackage()
inPackage
in interface com.sun.tools.doclets.Taglet
true
public boolean inType()
inType
in interface com.sun.tools.doclets.Taglet
true
public boolean isInlineTag()
isInlineTag
in interface com.sun.tools.doclets.Taglet
false
public abstract 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 tagpublic abstract 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 |