| java.lang.Object
 com.sun.tools.javadoc.TagImpl
com.sun.tools.javadoc.SeeTagImpl
| SeeTagImpl | | class SeeTagImpl extends TagImpl implements SeeTag,LayoutCharacters(Code) | | Represents a see also documentation tag.
The @see tag can be plain text, or reference a class or member.
version:
06/10/97
author:
Kaiyang Liu (original)
author:
Robert Field (rewrite)
author:
Atul M Dambalkar |
| Inner Class :class ParameterParseMachine | |
| Method Summary | |
| public String | kind()
Return the kind of this tag. | | public String | label()
Return the label of the see tag. | | 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) . | | public String | referencedClassName()
get the class name part of @see, For instance,
if the comment is @see String#startsWith(java.lang.String) . | | 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) . | | public 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) . | | public PackageDoc | referencedPackage()
get the package referenced by @see. |
| label | | public String label()(Code) | | Return the label of the see tag.
|
| referencedClass | | public ClassDoc referencedClass()(Code) | | 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..
|
| referencedClassName | | public String referencedClassName()(Code) | | 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..
|
| referencedMember | | public MemberDoc referencedMember()(Code) | | 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.
|
| referencedMemberName | | public String referencedMemberName()(Code) | | 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..
|
| referencedPackage | | public PackageDoc referencedPackage()(Code) | | 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.
|
|
|