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
  • Method Details Link icon

    • isTypeParameter Link icon

      boolean isTypeParameter()
      Returns true if this is documenting a type parameter.
      Returns:
      true if this is documenting a type parameter
    • getName Link icon

      IdentifierTree getName()
      Returns the name of the parameter.
      Returns:
      the name of the parameter
    • getDescription Link icon

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