-
- All Superinterfaces:
Tag
@Deprecated(since="9", forRemoval=true) public interface ParamTag extends Tag
Deprecated, for removal: This API element is subject to removal in a future version.The declarations in this package have been superseded by those in the packagejdk.javadoc.doclet
. For more information, see the Migration Guide in the documentation for that package.Represents an @param documentation tag. Stores the name and comment parts of the parameter tag. An @param tag may represent either a method or constructor parameter, or a type parameter.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
isTypeParameter()
Deprecated, for removal: This API element is subject to removal in a future version.Return true if thisParamTag
corresponds to a type parameter.String
parameterComment()
Deprecated, for removal: This API element is subject to removal in a future version.Return the parameter comment associated with thisParamTag
.String
parameterName()
Deprecated, for removal: This API element is subject to removal in a future version.Return the name of the parameter or type parameter associated with thisParamTag
.-
Methods declared in interface com.sun.javadoc.Tag
firstSentenceTags, holder, inlineTags, kind, name, position, text, toString
-
-
-
-
Method Detail
-
parameterName
String parameterName()
Deprecated, for removal: This API element is subject to removal in a future version.Return the name of the parameter or type parameter associated with thisParamTag
. The angle brackets delimiting a type parameter are not part of its name.- Returns:
- the parameter name.
-
parameterComment
String parameterComment()
Deprecated, for removal: This API element is subject to removal in a future version.Return the parameter comment associated with thisParamTag
.- Returns:
- the parameter comment.
-
isTypeParameter
boolean isTypeParameter()
Deprecated, for removal: This API element is subject to removal in a future version.Return true if thisParamTag
corresponds to a type parameter. Return false if it corresponds to an ordinary parameter of a method or constructor.- Returns:
- true if this
ParamTag
corresponds to a type parameter. - Since:
- 1.5
-
-