author | ksrini |
Fri, 09 Feb 2018 13:58:17 -0800 | |
changeset 48840 | 5e2d2067da48 |
parent 47216 | 71c04702a3d5 |
permissions | -rw-r--r-- |
10 | 1 |
/* |
48840
5e2d2067da48
8194651: javadoc: mark the com.sun.javadoc API for removal
ksrini
parents:
47216
diff
changeset
|
2 |
* Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved. |
10 | 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 |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 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 |
* |
|
5520 | 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. |
|
10 | 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 |
* |
|
38617 | 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. |
|
10 | 40 |
*/ |
48840
5e2d2067da48
8194651: javadoc: mark the com.sun.javadoc API for removal
ksrini
parents:
47216
diff
changeset
|
41 |
@Deprecated(since="9", forRemoval=true) |
5e2d2067da48
8194651: javadoc: mark the com.sun.javadoc API for removal
ksrini
parents:
47216
diff
changeset
|
42 |
@SuppressWarnings("removal") |
10 | 43 |
public interface ParamTag extends Tag { |
44 |
||
45 |
/** |
|
46 |
* Return the name of the parameter or type parameter |
|
23137
209daac13c8b
8035878: javadoc tool documentation should be using {@code ..} specifier
jjg
parents:
5520
diff
changeset
|
47 |
* associated with this {@code ParamTag}. |
10 | 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 |
|
23137
209daac13c8b
8035878: javadoc tool documentation should be using {@code ..} specifier
jjg
parents:
5520
diff
changeset
|
57 |
* associated with this {@code ParamTag}. |
10 | 58 |
* |
59 |
* @return the parameter comment. |
|
60 |
*/ |
|
61 |
String parameterComment(); |
|
62 |
||
63 |
/** |
|
23137
209daac13c8b
8035878: javadoc tool documentation should be using {@code ..} specifier
jjg
parents:
5520
diff
changeset
|
64 |
* Return true if this {@code ParamTag} corresponds to a type |
10 | 65 |
* parameter. Return false if it corresponds to an ordinary parameter |
66 |
* of a method or constructor. |
|
67 |
* |
|
23137
209daac13c8b
8035878: javadoc tool documentation should be using {@code ..} specifier
jjg
parents:
5520
diff
changeset
|
68 |
* @return true if this {@code ParamTag} corresponds to a type |
10 | 69 |
* parameter. |
70 |
* @since 1.5 |
|
71 |
*/ |
|
72 |
boolean isTypeParameter(); |
|
73 |
} |