src/jdk.compiler/share/classes/com/sun/source/doctree/ParamTree.java

Print this page




  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.source.doctree;
  27 
  28 import java.util.List;
  29 
  30 /**
  31  * A tree node for an @param block tag.
  32  *
  33  * <p>
  34  * @param parameter-name description
  35  *
  36  * @since 1.8
  37  */
  38 @jdk.Exported
  39 public interface ParamTree extends BlockTagTree {
  40     /**
  41      * Returns true if this is documenting a type parameter.
  42      * @return true if this is documenting a type parameter
  43      */
  44     boolean isTypeParameter();
  45 
  46     /**
  47      * Returns the name of the parameter.
  48      * @return the name of the parameter
  49      */
  50     IdentifierTree getName();
  51 
  52     /**
  53      * Returns the description of the parameter.
  54      * @return the description
  55      */
  56     List<? extends DocTree> getDescription();
  57 }


  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.source.doctree;
  27 
  28 import java.util.List;
  29 
  30 /**
  31  * A tree node for an @param block tag.
  32  *
  33  * <p>
  34  * @param parameter-name description
  35  *
  36  * @since 1.8
  37  */

  38 public interface ParamTree extends BlockTagTree {
  39     /**
  40      * Returns true if this is documenting a type parameter.
  41      * @return true if this is documenting a type parameter
  42      */
  43     boolean isTypeParameter();
  44 
  45     /**
  46      * Returns the name of the parameter.
  47      * @return the name of the parameter
  48      */
  49     IdentifierTree getName();
  50 
  51     /**
  52      * Returns the description of the parameter.
  53      * @return the description
  54      */
  55     List<? extends DocTree> getDescription();
  56 }