Class SimpleTaglet
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.SimpleTaglet
- All Implemented Interfaces:
InheritableTaglet
,Taglet
Deprecated.
A simple single argument custom 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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Deprecated.Use in location string when the tag is to appear in all locations.static final String
Deprecated.The marker in the location string for constructors.static final String
Deprecated.The marker in the location string for excluded tags.static final String
Deprecated.The marker in the location string for fields.protected String
Deprecated.The header to output.protected String
Deprecated.The possible locations that this tag can appear in.static final String
Deprecated.The marker in the location string for methods.static final String
Deprecated.The marker in the location string for overview.static final String
Deprecated.The marker in the location string for packages.protected String
Deprecated.The name of this tag.static final String
Deprecated.The marker in the location string for types.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
name
-
Constructor Summary
ConstructorsConstructorDescriptionSimpleTaglet
(String tagName, String header, String locations) Deprecated.Construct aSimpleTaglet
. -
Method Summary
Modifier and TypeMethodDescriptiongetName()
Deprecated.Return the name of thisTaglet
.getTagletOutput
(Doc holder, TagletWriter writer) Deprecated.Given aDoc
object, check if it holds any tags of this type.getTagletOutput
(Tag tag, TagletWriter writer) Deprecated.Given theTag
representation of this custom tag, return its Content representation, which is output to the generated page.boolean
Deprecated.Return true if thisSimpleTaglet
is used in constructor documentation.boolean
inField()
Deprecated.Return true if thisSimpleTaglet
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 thisSimpleTaglet
is used in method documentation.boolean
Deprecated.Return true if thisSimpleTaglet
is used in overview documentation.boolean
Deprecated.Return true if thisSimpleTaglet
is used in package documentation.boolean
inType()
Deprecated.Return true if thisSimpleTaglet
is used in type documentation (classes or interfaces).boolean
Deprecated.Return true if thisTaglet
is an inline tag.
-
Field Details
-
EXCLUDED
Deprecated.The marker in the location string for excluded tags.- See Also:
-
PACKAGE
Deprecated.The marker in the location string for packages.- See Also:
-
TYPE
Deprecated.The marker in the location string for types.- See Also:
-
CONSTRUCTOR
Deprecated.The marker in the location string for constructors.- See Also:
-
FIELD
Deprecated.The marker in the location string for fields.- See Also:
-
METHOD
Deprecated.The marker in the location string for methods.- See Also:
-
OVERVIEW
Deprecated.The marker in the location string for overview.- See Also:
-
ALL
Deprecated.Use in location string when the tag is to appear in all locations.- See Also:
-
tagName
Deprecated.The name of this tag. -
header
Deprecated.The header to output. -
locations
Deprecated.The possible locations that this tag can appear in.
-
-
Constructor Details
-
SimpleTaglet
Deprecated.Construct aSimpleTaglet
.- Parameters:
tagName
- the name of this tagheader
- the header to output.locations
- the possible locations that this tag can appear in. TheString
can contain 'p' for package, 't' for type, 'm' for method, 'c' for constructor and 'f' for field.
-
-
Method Details
-
getName
Deprecated.Return the name of thisTaglet
.- Specified by:
getName
in interfaceTaglet
- Overrides:
getName
in classBaseTaglet
- Returns:
- the name of this custom tag.
-
inConstructor
public boolean inConstructor()Deprecated.Return true if thisSimpleTaglet
is used in constructor documentation.- Specified by:
inConstructor
in interfaceTaglet
- Overrides:
inConstructor
in classBaseTaglet
- Returns:
- true if this
SimpleTaglet
is used in constructor documentation and false otherwise.
-
inField
public boolean inField()Deprecated.Return true if thisSimpleTaglet
is used in field documentation.- Specified by:
inField
in interfaceTaglet
- Overrides:
inField
in classBaseTaglet
- Returns:
- true if this
SimpleTaglet
is used in field documentation and false otherwise.
-
inMethod
public boolean inMethod()Deprecated.Return true if thisSimpleTaglet
is used in method documentation.- Specified by:
inMethod
in interfaceTaglet
- Overrides:
inMethod
in classBaseTaglet
- Returns:
- true if this
SimpleTaglet
is used in method documentation and false otherwise.
-
inOverview
public boolean inOverview()Deprecated.Return true if thisSimpleTaglet
is used in overview documentation.- Specified by:
inOverview
in interfaceTaglet
- Overrides:
inOverview
in classBaseTaglet
- Returns:
- true if this
SimpleTaglet
is used in overview documentation and false otherwise.
-
inPackage
public boolean inPackage()Deprecated.Return true if thisSimpleTaglet
is used in package documentation.- Specified by:
inPackage
in interfaceTaglet
- Overrides:
inPackage
in classBaseTaglet
- Returns:
- true if this
SimpleTaglet
is used in package documentation and false otherwise.
-
inType
public boolean inType()Deprecated.Return true if thisSimpleTaglet
is used in type documentation (classes or interfaces).- Specified by:
inType
in interfaceTaglet
- Overrides:
inType
in classBaseTaglet
- Returns:
- true if this
SimpleTaglet
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.
-
inherit
Deprecated.Description copied from interface:InheritableTaglet
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.
-
getTagletOutput
Deprecated.Given theTag
representation of this custom tag, return its Content representation, which is output to the generated page.- Specified by:
getTagletOutput
in interfaceTaglet
- Overrides:
getTagletOutput
in classBaseTaglet
- Parameters:
tag
- theTag
representation of this custom tag.writer
- aTagletWriter
Taglet writer.- Returns:
- the Content representation of this
Tag
.
-
getTagletOutput
Deprecated.Given aDoc
object, check if it holds any tags of this type. If it does, return the string representing the output. If it does not, return null.- Specified by:
getTagletOutput
in interfaceTaglet
- Overrides:
getTagletOutput
in classBaseTaglet
- Parameters:
holder
- aDoc
object holding the custom tag.writer
- aTagletWriter
Taglet writer.- Returns:
- the TagletOutput representation of this
Tag
.
-