APIdia Launch Partner
Top Description Methods
com.sun.source.doctree

public Interface ReturnTree

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

A tree node for an @return block tag.
@return description
   {@return description}
Since
1.8

Method Summary

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

Returns:

the description
getDescription
()

Returns the description of the return value of a method.

public default boolean

Returns:

true if this instance is an inline tag, and false otherwise
isInline
()

Returns whether this instance is an inline tag.

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

Method Detail

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

Returns the description of the return value of a method.

Returns:List<? extends DocTree>

the description

isInlineback to summary
public default boolean isInline()

Returns whether this instance is an inline tag.

Implementation Specification

this implementation returns false.

Returns:boolean

true if this instance is an inline tag, and false otherwise

Since
16