Class ParamTaglet
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.ParamTaglet
-
- All Implemented Interfaces:
InheritableTaglet
,Taglet
@Deprecated public class ParamTaglet extends BaseTaglet implements InheritableTaglet
Deprecated.A taglet that represents the @param tag.This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.4
- Author:
- Jamie Ho
-
-
Field Summary
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
name
-
-
Constructor Summary
Constructors Constructor Description ParamTaglet()
Deprecated.Construct a ParamTaglet.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Content
getTagletOutput(Doc holder, TagletWriter writer)
Deprecated.Given an array ofParamTag
s,return its string representation.boolean
inField()
Deprecated.Return true if thisTaglet
is used in field documentation.void
inherit(DocFinder.Input input, DocFinder.Output output)
Deprecated.Given anDocFinder.Output
object, set its values with the appropriate information to inherit documentation.boolean
inMethod()
Deprecated.Return true if thisTaglet
is used in method documentation.boolean
inOverview()
Deprecated.Return true if thisTaglet
is used in overview documentation.boolean
inPackage()
Deprecated.Return true if thisTaglet
is used in package documentation.boolean
inType()
Deprecated.Return true if thisTaglet
is used in type documentation (classes or interfaces).boolean
isInlineTag()
Deprecated.Return true if thisTaglet
is an inline tag.-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
getName, getTagletOutput, inConstructor
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.Taglet
getName, getTagletOutput, inConstructor, toString
-
-
-
-
Method Detail
-
inherit
public void inherit(DocFinder.Input input, DocFinder.Output output)
Deprecated.Given anDocFinder.Output
object, set its values with the appropriate information to inherit documentation.- Specified by:
inherit
in interfaceInheritableTaglet
- Parameters:
input
- the input for documentation search.output
- the output for documentation search.
-
inField
public boolean inField()
Deprecated.Return true if thisTaglet
is used in field documentation.- Specified by:
inField
in interfaceTaglet
- Overrides:
inField
in classBaseTaglet
- Returns:
- true if this
Taglet
is used in field documentation and false otherwise.
-
inMethod
public boolean inMethod()
Deprecated.Return true if thisTaglet
is used in method documentation.- Specified by:
inMethod
in interfaceTaglet
- Overrides:
inMethod
in classBaseTaglet
- Returns:
- true if this
Taglet
is used in method documentation and false otherwise.
-
inOverview
public boolean inOverview()
Deprecated.Return true if thisTaglet
is used in overview documentation.- Specified by:
inOverview
in interfaceTaglet
- Overrides:
inOverview
in classBaseTaglet
- Returns:
- true if this
Taglet
is used in method documentation and false otherwise.
-
inPackage
public boolean inPackage()
Deprecated.Return true if thisTaglet
is used in package documentation.- Specified by:
inPackage
in interfaceTaglet
- Overrides:
inPackage
in classBaseTaglet
- Returns:
- true if this
Taglet
is used in package documentation and false otherwise.
-
inType
public boolean inType()
Deprecated.Return true if thisTaglet
is used in type documentation (classes or interfaces).- Specified by:
inType
in interfaceTaglet
- Overrides:
inType
in classBaseTaglet
- Returns:
- true if this
Taglet
is used in type documentation and false otherwise.
-
isInlineTag
public boolean isInlineTag()
Deprecated.Return true if thisTaglet
is an inline tag.- Specified by:
isInlineTag
in interfaceTaglet
- Overrides:
isInlineTag
in classBaseTaglet
- Returns:
- true if this
Taglet
is an inline tag and false otherwise.
-
getTagletOutput
public Content getTagletOutput(Doc holder, TagletWriter writer)
Deprecated.Given an array ofParamTag
s,return its string representation.- Specified by:
getTagletOutput
in interfaceTaglet
- Overrides:
getTagletOutput
in classBaseTaglet
- Parameters:
holder
- the member that holds the param tags.writer
- the TagletWriter that will write this tag.- Returns:
- the TagletOutput representation of these
ParamTag
s.
-
-