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

public Interface ParamTree

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

A tree node for an @param block tag.
   @param parameter-name description
Since
1.8

Method Summary

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

Returns:

the description
getDescription
()

Returns the description of the parameter.

public IdentifierTree

Returns:

the name of the parameter
getName
()

Returns the name of the parameter.

public boolean

Returns:

true if this is documenting a type parameter
isTypeParameter
()

Returns true if this is documenting a type parameter.

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

Method Detail

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

Returns the description of the parameter.

Returns:List<? extends DocTree>

the description

getNameback to summary
public IdentifierTree getName()

Returns the name of the parameter.

Returns:IdentifierTree

the name of the parameter

isTypeParameterback to summary
public boolean isTypeParameter()

Returns true if this is documenting a type parameter.

Returns:boolean

true if this is documenting a type parameter