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.
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
-
Field Summary
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
name
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate Content
getInheritedTagletOutput
(boolean isNonTypeParams, Doc holder, TagletWriter writer, Object[] formalParameters, Set<String> alreadyDocumented) Deprecated.Loop through each indivitual parameter.getRankMap
(Object[] params) Deprecated.Given an array ofParameter
s, return a name/rank number map.private Content
getTagletOutput
(boolean isNonTypeParams, Doc holder, TagletWriter writer, Object[] formalParameters, ParamTag[] paramTags) Deprecated.Given an array ofParamTag
s,return its string representation.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
Deprecated.Return true if thisTaglet
is used in overview documentation.boolean
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
Deprecated.Return true if thisTaglet
is an inline tag.private Content
processParamTag
(boolean isNonTypeParams, TagletWriter writer, ParamTag paramTag, String name, boolean isFirstParam) Deprecated.Convert the individual ParamTag into Content.private Content
processParamTags
(boolean isNonTypeParams, ParamTag[] paramTags, Map<String, String> rankMap, TagletWriter writer, Set<String> alreadyDocumented) Deprecated.Given an array ofTag
s representing this custom tag, return its string representation.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
-
Constructor Details
-
ParamTaglet
public ParamTaglet()Deprecated.Construct a ParamTaglet.
-
-
Method Details
-
getRankMap
Deprecated.Given an array ofParameter
s, return a name/rank number map. If the array is null, then null is returned.- Parameters:
params
- The array of parmeters (from type or executable member) to check.- Returns:
- a name-rank number map.
-
inherit
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
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.
-
getTagletOutput
private Content getTagletOutput(boolean isNonTypeParams, Doc holder, TagletWriter writer, Object[] formalParameters, ParamTag[] paramTags) Deprecated.Given an array ofParamTag
s,return its string representation. Try to inherit the param tags that are missing.- Parameters:
holder
- the doc that holds the param tags.writer
- the TagletWriter that will write this tag.formalParameters
- The array of parmeters (from type or executable member) to check.- Returns:
- the TagletOutput representation of these
ParamTag
s.
-
getInheritedTagletOutput
private Content getInheritedTagletOutput(boolean isNonTypeParams, Doc holder, TagletWriter writer, Object[] formalParameters, Set<String> alreadyDocumented) Deprecated.Loop through each indivitual parameter. It it does not have a corresponding param tag, try to inherit it. -
processParamTags
private Content processParamTags(boolean isNonTypeParams, ParamTag[] paramTags, Map<String, String> rankMap, TagletWriter writer, Set<String> alreadyDocumented) Deprecated.Given an array ofTag
s representing this custom tag, return its string representation. Print a warning for param tags that do not map to parameters. Print a warning for param tags that are duplicated.- Parameters:
paramTags
- the array ofParamTag
s to convert.writer
- the TagletWriter that will write this tag.alreadyDocumented
- the set of exceptions that have already been documented.rankMap
- aMap
which holds ordering information about the parameters.rankMap
- aMap
which holds a mapping of a rank of a parameter to its name. This is used to ensure that the right name is used when parameter documentation is inherited.- Returns:
- the Content representation of this
Tag
.
-
processParamTag
private Content processParamTag(boolean isNonTypeParams, TagletWriter writer, ParamTag paramTag, String name, boolean isFirstParam) Deprecated.Convert the individual ParamTag into Content.- Parameters:
isNonTypeParams
- true if this is just a regular param tag. False if this is a type param tag.writer
- the taglet writer for output writing.paramTag
- the tag whose inline tags will be printed.name
- the name of the parameter. We can't rely on the name in the param tag because we might be inheriting documentation.isFirstParam
- true if this is the first param tag being printed.
-