1 /* 2 * Copyright (c) 2011, 2014, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 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 */ isTypeParameter()43 boolean isTypeParameter(); 44 45 /** 46 * Returns the name of the parameter. 47 * @return the name of the parameter 48 */ getName()49 IdentifierTree getName(); 50 51 /** 52 * Returns the description of the parameter. 53 * @return the description 54 */ getDescription()55 List<? extends DocTree> getDescription(); 56 } 57