IndexTree

IndexTree (@index 인라인 태그 노드)

문서 주석 안의 @index 인라인 태그를 표현하는 트리 노드입니다. 검색 색인에 포함할 키워드를 지정하는 데 쓰이는 태그예요.

출처: Java API Reference

다음과 같은 형태의 @index 인라인 태그를 나타냅니다. 검색어와, 선택적으로 설명을 함께 담습니다.

{@index keyword optional description}

Java 9부터 존재해요.

public interface IndexTree extends InlineTagTree

public DocTree getSearchTerm()

지정된 검색어(search term)를 반환합니다. 인덱스에 등록할 키워드 부분이 바로 이것이에요.

public List<? extends DocTree> getDescription()

설명(description)이 있다면 그 내용을 반환합니다. 검색어 다음에 오는 선택적 설명 부분으로, 없으면 빈 목록을 돌려줍니다.