Interface ParamTag

All Superinterfaces:
Tag
All Known Implementing Classes:
ParamTagImpl

@Deprecated public interface ParamTag extends Tag
Deprecated.
The declarations in this package have been superseded by those in the package jdk.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 Details

    • parameterName

      String parameterName()
      Deprecated.
      Return the name of the parameter or type parameter associated with this ParamTag. 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 this ParamTag.
      Returns:
      the parameter comment.
    • isTypeParameter

      boolean isTypeParameter()
      Deprecated.
      Return true if this ParamTag 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