Top Description Methods
com.sun.source.doctree

public Interface IndexTree

extends InlineTagTree
Known Direct Implementers
com.sun.tools.javac.tree.DCTree.DCIndex
Imports
java.util.List

A tree node for an @index inline tag.
   {@index keyword optional description}
Since
9

Method Summary

Modifier and TypeMethod and Description
public List<? extends DocTree>

Returns:

the description
getDescription
()

Returns the description, if any.

public DocTree

Returns:

the search term
getSearchTerm
()

Returns the specified search term.

Inherited from com.sun.source.doctree.InlineTagTree:
getTagName

Method Detail

getDescriptionback to summary
public List<? extends DocTree> getDescription()

Returns the description, if any.

Returns:List<? extends DocTree>

the description

getSearchTermback to summary
public DocTree getSearchTerm()

Returns the specified search term.

Returns:DocTree

the search term