1 /*

     2  * Copyright (c) 1998, 2018, 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 /**

    29  * Represents an @param documentation tag.

    30  * Stores the name and comment parts of the parameter tag.

    31  * An @param tag may represent either a method or constructor parameter,

    32  * or a type parameter.

    33  *

    34  * @author Robert Field

    35  *

    36  * @deprecated

    37  *   The declarations in this package have been superseded by those

    38  *   in the package {@code jdk.javadoc.doclet}.

    39  *   For more information, see the <i>Migration Guide</i> in the documentation for that package.

    40  */

    41 @Deprecated(since="9", forRemoval=true)

    42 @SuppressWarnings("removal")

    43 public interface ParamTag extends Tag {

    44 

    45     /**

    46      * Return the name of the parameter or type parameter

    47      * associated with this {@code ParamTag}.

    48      * The angle brackets delimiting a type parameter are not part of

    49      * its name.

    50      *

    51      * @return the parameter name.

    52      */

    53     String parameterName();

    54 

    55     /**

    56      * Return the parameter comment

    57      * associated with this {@code ParamTag}.

    58      *

    59      * @return the parameter comment.

    60      */

    61     String parameterComment();

    62 

    63     /**

    64      * Return true if this {@code ParamTag} corresponds to a type

    65      * parameter.  Return false if it corresponds to an ordinary parameter

    66      * of a method or constructor.

    67      *

    68      * @return true if this {@code ParamTag} corresponds to a type

    69      * parameter.

    70      * @since 1.5

    71      */

    72     boolean isTypeParameter();

    73 }