Top Description Fields Constructors Methods
jdk.javadoc.internal.doclets.formats.html.taglets

public Class IndexTaglet

extends BaseTaglet
Class Inheritance
Imports
java.util.EnumSet, javax.lang.model.element.Element, com.sun.source.doctree.DocTree, .IndexTree, .TextTree, jdk.javadoc.doclet.Taglet, jdk.javadoc.internal.doclets.formats.html.HtmlConfiguration, .Content
An inline taglet used to index a word or a phrase. The enclosed text is interpreted as not containing HTML markup or nested javadoc tags.

Field Summary

Inherited from jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet:
configmessagesnameresourcestagKindtagletWriterutils

Constructor Summary

AccessConstructor and Description
pack-priv
IndexTaglet(HtmlConfiguration config)

Method Summary

Modifier and TypeMethod and Description
private String
extractText(Content c)

public Content
getInlineTagOutput(Element
the element for the enclosing doc comment
element, DocTree
the tag
tag, TagletWriter
the taglet-writer used in this doclet
tagletWriter)

Overrides jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getInlineTagOutput.

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput.

Returns the content to be included in the generated output for an instance of an inline tag handled by this taglet.
Inherited from jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet:
getAllBlockTagOutputgetAllowedLocationsgetNamegetTagKindisInlineTag

Constructor Detail

IndexTagletback to summary
pack-priv IndexTaglet(HtmlConfiguration config)

Method Detail

extractTextback to summary
private String extractText(Content c)
getInlineTagOutputback to summary
public Content getInlineTagOutput(Element element, DocTree tag, TagletWriter tagletWriter)

Overrides jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getInlineTagOutput.

Implements jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput.

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.BaseTaglet.getInlineTagOutput.

Returns the content to be included in the generated output for an instance of an inline tag handled by this taglet.

Parameters
element:Element

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput.

the element for the enclosing doc comment

tag:DocTree

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput.

the tag

tagletWriter:TagletWriter

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput.

the taglet-writer used in this doclet

Returns:Content

Doc from jdk.javadoc.internal.doclets.formats.html.taglets.Taglet.getInlineTagOutput.

the output for this tag

Annotations
@Override