-
- All Superinterfaces:
Tag
Deprecated.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.
@Deprecated public interface ParamTag extends Tag
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 booleanisTypeParameter()Deprecated.Return true if thisParamTagcorresponds to a type parameter.StringparameterComment()Deprecated.Return the parameter comment associated with thisParamTag.StringparameterName()Deprecated.Return the name of the parameter or type parameter associated with thisParamTag.-
Methods inherited from interface com.sun.javadoc.Tag
firstSentenceTags, holder, inlineTags, kind, name, position, text, toString
-
-
-
-
Method Detail
-
parameterName
String parameterName()
Deprecated.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.Return the parameter comment associated with thisParamTag.- Returns:
- the parameter comment.
-
isTypeParameter
boolean isTypeParameter()
Deprecated.Return true if thisParamTagcorresponds to a type parameter. Return false if it corresponds to an ordinary parameter of a method or constructor.- Returns:
- true if this
ParamTagcorresponds to a type parameter. - Since:
- 1.5
-
-