W3cubDocs

/OpenJDK 21

Interface ParamTree

All Superinterfaces:
BlockTagTree, DocTree
public interface ParamTree extends BlockTagTree
A tree node for an @param block tag.
    @param parameter-name description
 
Since:
1.8

Nested Class Summary

Nested classes/interfaces declared in interface com.sun.source.doctree.DocTree

DocTree.Kind

Method Summary

Modifier and Type Method Description
List<? extends DocTree> getDescription()
Returns the description of the parameter.
IdentifierTree getName()
Returns the name of the parameter.
boolean isTypeParameter()
Returns true if this is documenting a type parameter.

Methods declared in interface com.sun.source.doctree.BlockTagTree

getTagName

Methods declared in interface com.sun.source.doctree.DocTree

accept, getKind

Method Details

isTypeParameter

boolean isTypeParameter()
Returns true if this is documenting a type parameter.
Returns:
true if this is documenting a type parameter

getName

IdentifierTree getName()
Returns the name of the parameter.
Returns:
the name of the parameter

getDescription

List<? extends DocTree> getDescription()
Returns the description of the parameter.
Returns:
the description

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.compiler/com/sun/source/doctree/ParamTree.html