aoqi@0: /*
aoqi@0:  * Copyright (c) 1998, 2003, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.javadoc;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Represents an @param documentation tag.
aoqi@0:  * Stores the name and comment parts of the parameter tag.
aoqi@0:  * An @param tag may represent either a method or constructor parameter,
aoqi@0:  * or a type parameter.
aoqi@0:  *
aoqi@0:  * @author Robert Field
aoqi@0:  *
aoqi@0:  */
aoqi@0: public interface ParamTag extends Tag {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return the name of the parameter or type parameter
aoqi@0:      * associated with this <code>ParamTag</code>.
aoqi@0:      * The angle brackets delimiting a type parameter are not part of
aoqi@0:      * its name.
aoqi@0:      *
aoqi@0:      * @return the parameter name.
aoqi@0:      */
aoqi@0:     String parameterName();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return the parameter comment
aoqi@0:      * associated with this <code>ParamTag</code>.
aoqi@0:      *
aoqi@0:      * @return the parameter comment.
aoqi@0:      */
aoqi@0:     String parameterComment();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return true if this <code>ParamTag</code> corresponds to a type
aoqi@0:      * parameter.  Return false if it corresponds to an ordinary parameter
aoqi@0:      * of a method or constructor.
aoqi@0:      *
aoqi@0:      * @return true if this <code>ParamTag</code> corresponds to a type
aoqi@0:      * parameter.
aoqi@0:      * @since 1.5
aoqi@0:      */
aoqi@0:     boolean isTypeParameter();
aoqi@0: }