Class sun.tools.javadoc.SeeTag
java.lang.Object
|
+----sun.tools.javadoc.Tag
|
+----sun.tools.javadoc.SeeTag
- public class SeeTag
- extends Tag
Represents a see also documentation tag.
The @see tag can be plain text, or reference a class or member.
Method Summary
|
java.lang.String
|
kind()
Return the kind of this tag.
|
ClassDoc
|
referencedClass()
get the class referenced by the class name part of @see, For instance,
if the comment is @see String#startsWith(java.lang.String) .
|
java.lang.String
|
referencedClassName()
get the class name part of @see, For instance,
if the comment is @see String#startsWith(java.lang.String) .
|
MemberDoc
|
referencedMember()
get the member referenced by the prototype part of @see,
For instance,
if the comment is @see String#startsWith(java.lang.String) .
|
java.lang.String
|
referencedMemberName()
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) .
|
Methods inherited from class java.lang.Object
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
referencedClassName
public java.lang.String referencedClassName()
- 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..
referencedClass
public ClassDoc referencedClass()
- 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 ClassDoc for java.lang.String.
Returns null if class is not a class specified on the javadoc command line..
referencedMemberName
public java.lang.String referencedMemberName()
- 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..
referencedMember
public MemberDoc referencedMember()
- 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 MethodDoc for startsWith.
Returns null if member could not be determined.
kind
public java.lang.String kind()
- Return the kind of this tag.
- Overrides:
- kind in class Tag