Class IndexTaglet
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseInlineTaglet
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.IndexTaglet
-
- All Implemented Interfaces:
Taglet
@Deprecated public class IndexTaglet extends BaseInlineTaglet
Deprecated.An inline Taglet used to index word or a phrase. The enclosed text is interpreted as not containing HTML markup or nested javadoc tags.- Author:
- Bhavesh Patel
-
-
Field Summary
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
name
-
-
Constructor Summary
Constructors Constructor Description IndexTaglet()
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
getName()
Deprecated.Return the name of this custom tag.Content
getTagletOutput(Tag tag, TagletWriter writer)
Deprecated.Given theTag
representation of this custom tag, return its Content representation, which is output to the generated page.static void
register(Map<String,Taglet> map)
Deprecated.-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseInlineTaglet
isInlineTag
-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
getTagletOutput, inConstructor, inField, inMethod, inOverview, inPackage, inType
-
-
-
-
Method Detail
-
getName
public String getName()
Deprecated.Description copied from class:BaseTaglet
Return the name of this custom tag.- Specified by:
getName
in interfaceTaglet
- Overrides:
getName
in classBaseTaglet
- Returns:
- the name of this custom tag.
-
getTagletOutput
public Content getTagletOutput(Tag tag, TagletWriter writer)
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
.
-
-