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.

Field Summary

Fields

Modifier and Type

Field

Description

private static final String

NAME

Deprecated.

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.BaseTaglet
name
Constructor Summary

Constructors

Constructor

Description

IndexTaglet()

Deprecated.
Method Summary

Modifier and Type

Method

Description

String

getName()

Deprecated.

Return the name of this custom tag.

Content

getTagletOutput(Tag tag, TagletWriter writer)

Deprecated.

Given the Tag 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

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
toString

Field Details
- NAME
  
  private static final String NAME
  
  Deprecated.
  See Also:
  
  Constant Field Values
Constructor Details
- IndexTaglet
  
  public IndexTaglet()
  
  Deprecated.
Method Details
- register
  
  public static void register(Map<String,Taglet> map)
  
  Deprecated.
- getName
  
  public String getName()
  
  Deprecated.
  
  Description copied from class: BaseTaglet
  
  Return the name of this custom tag.
  
  Specified by:
  
  getName in interface Taglet
  
  Overrides:
  
  getName in class BaseTaglet
  
  Returns:
  
  the name of this custom tag.
- getTagletOutput
  
  public Content getTagletOutput(Tag tag, TagletWriter writer)
  
  Deprecated.
  
  Given the Tag representation of this custom tag, return its Content representation, which is output to the generated page.
  
  Specified by:
  
  getTagletOutput in interface Taglet
  
  Overrides:
  
  getTagletOutput in class BaseTaglet
  
  Parameters:
  
  tag - the Tag representation of this custom tag.
  
  writer - a TagletWriter Taglet writer.
  
  Returns:
  
  the Content representation of this Tag.