|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.h2b.taglets.InlineTaglet
@ClassLabel(copyright="Copyright (C) 2008 Hans-Hermann Bode", ident="$Id: InlineTaglet.java,v 1.4 2008/12/14 17:05:37 h2b Exp $") public abstract class InlineTaglet
An abstract class that represents a Javadoc inline taglet. It implements all
in...
methods of Taglet
so that it can be used in
documentation for all program elements.
Constructor Summary | |
---|---|
InlineTaglet()
|
Method Summary | |
---|---|
abstract java.lang.String |
getName()
Returns the name of this custom tag. |
boolean |
inConstructor()
Will return false since it is an inline tag. |
boolean |
inField()
Will return false since it is an inline tag. |
boolean |
inMethod()
Will return false since it is an inline tag. |
boolean |
inOverview()
Will return false since it is an inline tag. |
boolean |
inPackage()
Will return false since it is an inline tag. |
boolean |
inType()
Will return false since it is an inline tag. |
boolean |
isInlineTag()
Will return true since it is 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. |
java.lang.String |
toString(com.sun.javadoc.Tag[] tags)
This method should not be called since arrays of inline tags do not exist. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public InlineTaglet()
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
false
public boolean inConstructor()
inConstructor
in interface com.sun.tools.doclets.Taglet
false
public boolean inMethod()
inMethod
in interface com.sun.tools.doclets.Taglet
false
public boolean inOverview()
inOverview
in interface com.sun.tools.doclets.Taglet
false
public boolean inPackage()
inPackage
in interface com.sun.tools.doclets.Taglet
false
public boolean inType()
inType
in interface com.sun.tools.doclets.Taglet
false
public boolean isInlineTag()
isInlineTag
in interface com.sun.tools.doclets.Taglet
true
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 java.lang.String toString(com.sun.javadoc.Tag[] tags)
toString(Tag)
should be used to convert this
inline tag to a string.
toString
in interface com.sun.tools.doclets.Taglet
tags
- the array of Tag
s representing this custom
tag
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |