Class ParamTagImpl

java.lang.Object
gw.gosudoc.com.sun.tools.javadoc.main.TagImpl
gw.gosudoc.com.sun.tools.javadoc.main.ParamTagImpl
All Implemented Interfaces:
ParamTag, Tag

@Deprecated class ParamTagImpl extends TagImpl implements ParamTag
Deprecated.
Represents an @param documentation tag. Parses and stores the name and comment parts of the parameter tag.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

  • Field Details

    • typeParamRE

      private static final Pattern typeParamRE
      Deprecated.
    • parameterName

      private final String parameterName
      Deprecated.
    • parameterComment

      private final String parameterComment
      Deprecated.
    • isTypeParameter

      private final boolean isTypeParameter
      Deprecated.
    • inlineTags

      private Tag[] inlineTags
      Deprecated.
      Cached inline tags.
  • Constructor Details

  • Method Details

    • parameterName

      public String parameterName()
      Deprecated.
      Return the parameter name.
      Specified by:
      parameterName in interface ParamTag
      Returns:
      the parameter name.
    • parameterComment

      public String parameterComment()
      Deprecated.
      Return the parameter comment.
      Specified by:
      parameterComment in interface ParamTag
      Returns:
      the parameter comment.
    • kind

      public String kind()
      Deprecated.
      Return the kind of this tag.
      Specified by:
      kind in interface Tag
      Overrides:
      kind in class TagImpl
      Returns:
      the kind of this tag.
    • isTypeParameter

      public boolean isTypeParameter()
      Deprecated.
      Return true if this ParamTag corresponds to a type parameter.
      Specified by:
      isTypeParameter in interface ParamTag
      Returns:
      true if this ParamTag corresponds to a type parameter.
    • toString

      public String toString()
      Deprecated.
      convert this object to a string.
      Specified by:
      toString in interface Tag
      Overrides:
      toString in class TagImpl
    • inlineTags

      public Tag[] inlineTags()
      Deprecated.
      For the parameter comment with embedded @link tags return the array of TagImpls consisting of SeeTagImpl(s) and text containing TagImpl(s).
      Specified by:
      inlineTags in interface Tag
      Overrides:
      inlineTags in class TagImpl
      Returns:
      TagImpl[] Array of tags with inline SeeTagImpls.
      See Also: