Package gw.gosudoc.com.sun.tools.javadoc.main

Class SeeTagImpl

java.lang.Object
gw.gosudoc.com.sun.tools.javadoc.main.TagImpl
gw.gosudoc.com.sun.tools.javadoc.main.SeeTagImpl
All Implemented Interfaces:
com.sun.tools.javac.util.LayoutCharacters, SeeTag, Tag
@Deprecated class SeeTagImpl extends TagImpl implements SeeTag, com.sun.tools.javac.util.LayoutCharacters
Deprecated.
Represents a see also documentation tag. The @see tag can be plain text, or reference a class or member.

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

    • where

      private String where
      Deprecated.
      where of where#what - i.e. the class name (may be empty)

    • what

      private String what
      Deprecated.
      what of where#what - i.e. the member (may be null)

    • referencedPackage

      private PackageDoc referencedPackage
      Deprecated.

    • referencedClass

      private ClassDoc referencedClass
      Deprecated.

    • referencedMember

      private MemberDoc referencedMember
      Deprecated.

    • label

      String label
      Deprecated.

    • showRef

      private static final boolean showRef
      Deprecated.
      See Also:

  • Constructor Details

  • Method Details

    • showRef

      private void showRef()
      Deprecated.

    • referencedClassName

      public String referencedClassName()
      Deprecated.
      get the class name part of @see, For instance, if the comment is @see String#startsWith(java.lang.String) . This function returns String. Returns null if format was not that of java reference. Return empty string if class name was not specified..
      Specified by:
      referencedClassName in interface SeeTag
      Returns:
      null if @see references a non-element, such as @see <a href="java.sun.com">.

    • referencedPackage

      public PackageDoc referencedPackage()
      Deprecated.
      get the package referenced by @see. For instance, if the comment is @see java.lang This function returns a PackageDocImpl for java.lang Returns null if no known package found.
      Specified by:
      referencedPackage in interface SeeTag
      Returns:
      the PackageDoc for java.lang.

    • referencedClass

      public ClassDoc referencedClass()
      Deprecated.
      get the class referenced by the class name part of @see, For instance, if the comment is @see String#startsWith(java.lang.String) . This function returns a ClassDocImpl for java.lang.String. Returns null if class is not a class specified on the javadoc command line..
      Specified by:
      referencedClass in interface SeeTag
      Returns:
      the ClassDoc for java.lang.String.

    • referencedMemberName

      public String referencedMemberName()
      Deprecated.
      get the name of the member referenced by the prototype part of @see, For instance, if the comment is @see String#startsWith(java.lang.String) . This function returns "startsWith(java.lang.String)" Returns null if format was not that of java reference. Return empty string if member name was not specified..
      Specified by:
      referencedMemberName in interface SeeTag
      Returns:
      "startsWith(String)".

    • referencedMember

      public MemberDoc referencedMember()
      Deprecated.
      get the member referenced by the prototype part of @see, For instance, if the comment is @see String#startsWith(java.lang.String) . This function returns a MethodDocImpl for startsWith. Returns null if member could not be determined.
      Specified by:
      referencedMember in interface SeeTag
      Returns:
      the MethodDoc for startsWith.

    • parseSeeString

      private void parseSeeString()
      Deprecated.
      parse @see part of comment. Determine 'where' and 'what'

    • findReferenced

      private void findReferenced(ClassDocImpl containingClass)
      Deprecated.
      Find what is referenced by the see also. If possible, sets referencedClass and referencedMember.
      Parameters:
      containingClass - the class containing the comment containing the tag. May be null, if, for example, it is a package comment.

    • findReferencedMethod

      private MemberDoc findReferencedMethod(String memName, String[] paramarr, ClassDoc referencedClass)
      Deprecated.

    • findExecutableMember

      private MemberDoc findExecutableMember(String memName, String[] paramarr, ClassDoc referencedClass)
      Deprecated.

    • 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.

    • label

      public String label()
      Deprecated.
      Return the label of the see tag.
      Specified by:
      label in interface SeeTag
      Returns:
      "the trim method".