Module jdk.compiler

Interface IndexTree

All Superinterfaces:
DocTree, InlineTagTree

public interface IndexTree extends InlineTagTree
A tree node for an @index inline tag.
    {@index keyword optional description}
 
Since:
9
  • Method Details

    • getSearchTerm

      DocTree getSearchTerm()
      Returns the specified search term.
      Returns:
      the search term
    • getDescription

      List<? extends DocTree> getDescription()
      Returns the description, if any.
      Returns:
      the description