1 /* 2 * Copyright (c) 1998, 2003, 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.javadoc; 27 28 import com.google.doclava.annotation.Used; 29 30 /** 31 * Represents an @param documentation tag. 32 * Stores the name and comment parts of the parameter tag. 33 * An @param tag may represent either a method or constructor parameter, 34 * or a type parameter. 35 * 36 * @author Robert Field 37 * 38 */ 39 public interface ParamTag extends Tag { 40 41 /** 42 * Return the name of the parameter or type parameter 43 * associated with this <code>ParamTag</code>. 44 * The angle brackets delimiting a type parameter are not part of 45 * its name. 46 * 47 * @return the parameter name. 48 */ 49 @Used parameterName()50 String parameterName(); 51 52 /** 53 * Return the parameter comment 54 * associated with this <code>ParamTag</code>. 55 * 56 * @return the parameter comment. 57 */ 58 @Used parameterComment()59 String parameterComment(); 60 61 /** 62 * Return true if this <code>ParamTag</code> corresponds to a type 63 * parameter. Return false if it corresponds to an ordinary parameter 64 * of a method or constructor. 65 * 66 * @return true if this <code>ParamTag</code> corresponds to a type 67 * parameter. 68 * @since 1.5 69 */ 70 @Used isTypeParameter()71 boolean isTypeParameter(); 72 } 73