Class SeeTagImpl
java.lang.Object
gw.gosudoc.com.sun.tools.javadoc.main.TagImpl
gw.gosudoc.com.sun.tools.javadoc.main.SeeTagImpl
@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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) class
Deprecated. -
Field Summary
FieldsModifier and TypeFieldDescription(package private) String
Deprecated.private ClassDoc
Deprecated.private MemberDoc
Deprecated.private PackageDoc
Deprecated.private static final boolean
Deprecated.private String
Deprecated.what of where#what - i.e.private String
Deprecated.where of where#what - i.e.Fields inherited from interface com.sun.tools.javac.util.LayoutCharacters
CR, DetailsInc, DiagInc, EOI, FF, LF, TAB, TabInc
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate MemberDoc
findExecutableMember
(String memName, String[] paramarr, ClassDoc referencedClass) Deprecated.private void
findReferenced
(ClassDocImpl containingClass) Deprecated.Find what is referenced by the see also.private MemberDoc
findReferencedMethod
(String memName, String[] paramarr, ClassDoc referencedClass) Deprecated.kind()
Deprecated.Return the kind of this tag.label()
Deprecated.Return the label of the see tag.private void
Deprecated.parse @see part of comment.Deprecated.get the class referenced by the class name part of @see, For instance, if the comment is @see String#startsWith(java.lang.String) .Deprecated.get the class name part of @see, For instance, if the comment is @see String#startsWith(java.lang.String) .Deprecated.get the member referenced by the prototype part of @see, For instance, if the comment is @see String#startsWith(java.lang.String) .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) .Deprecated.get the package referenced by @see.private void
showRef()
Deprecated.Methods inherited from class gw.gosudoc.com.sun.tools.javadoc.main.TagImpl
divideAtWhite, docenv, firstSentenceTags, holder, inlineTags, name, position, text, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface gw.gosudoc.com.sun.javadoc.Tag
firstSentenceTags, holder, inlineTags, name, position, text, toString
-
Field Details
-
where
Deprecated.where of where#what - i.e. the class name (may be empty) -
what
Deprecated.what of where#what - i.e. the member (may be null) -
referencedPackage
Deprecated. -
referencedClass
Deprecated. -
referencedMember
Deprecated. -
label
String labelDeprecated. -
showRef
private static final boolean showRefDeprecated.- See Also:
-
-
Constructor Details
-
SeeTagImpl
Deprecated.
-
-
Method Details
-
showRef
private void showRef()Deprecated. -
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 interfaceSeeTag
- Returns:
- null if
@see
references a non-element, such as@see <a href="java.sun.com">
.
-
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 interfaceSeeTag
- Returns:
- the
PackageDoc
forjava.lang
.
-
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 interfaceSeeTag
- Returns:
- the
ClassDoc
forjava.lang.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 interfaceSeeTag
- Returns:
- "startsWith(String)".
-
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 interfaceSeeTag
- Returns:
- the
MethodDoc
forstartsWith
.
-
parseSeeString
private void parseSeeString()Deprecated.parse @see part of comment. Determine 'where' and 'what' -
findReferenced
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
Deprecated. -
findExecutableMember
Deprecated. -
kind
Deprecated.Return the kind of this tag. -
label
Deprecated.Return the label of the see tag.
-