ReturnTree

ReturnTree (@return 문서 태그 노드)

문서 주석 안의 @return 태그를 표현하는 트리 노드입니다. 메서드의 반환 값을 설명하는 데 쓰이며, 블록 태그와 인라인 태그 두 형태를 모두 지원해요.

출처: Java API Reference

다음과 같은 두 가지 형태의 @return 태그를 나타냅니다.

@return description
{@return description}

첫째는 문단 단위의 블록 태그, 둘째는 문장 중간에 넣는 인라인 태그 형태예요. Java 1.8부터 존재합니다.

public interface ReturnTree extends BlockTagTree, InlineTagTree

public List<? extends DocTree> getDescription()

메서드의 반환 값에 대한 설명을 반환합니다.

default boolean isInline()

이 인스턴스가 인라인 태그인지 여부를 반환합니다. 기본 구현은 false를 돌려주는데, 인라인 형태로 파싱된 노드는 이를 오버라이드해 true를 반환해요. Java 16부터 추가되었습니다.