SeeTag (SinjDoc 0.5 documentation)

Interface SeeTag

public interface SeeTag extends Tag

The SeeTag class represents a "see also" documentation tag. The @see tag can be plain text, or reference a class or member.

Version: $Id: SeeTag.java,v 1.6 2003/05/08 03:54:25 cananian Exp $

Author: C. Scott Ananian (cscott@cscott.net)

See Also: com.sun.javadoc.SeeTag

Method Summary
List<Tag>	label() Return the label of the see tag.
ClassDoc	referencedClass() Return the class referenced by the class name part of @see, or `null` if the class is not a class specified on the SinjDoc command line.
String	referencedClassName() Return the class name part of @see.
MemberDoc	referencedMember() Return the member referenced by @see, or `null` if the member could not be determined or was not in the included set.
String	referencedMemberName() Return the name of the member referenced by @see.
PackageDoc	referencedPackage() Return the package referenced by @see, or `null` if no known package found.

Method Summary

List<Tag>

label()

Return the label of the see tag.

ClassDoc

referencedClass()

Return the class referenced by the class name part of @see, or null if the class is not a class specified on the SinjDoc command line.

String

referencedClassName()

Return the class name part of @see.

MemberDoc

referencedMember()

Return the member referenced by @see, or null if the member could not be determined or was not in the included set.

String

referencedMemberName()

Return the name of the member referenced by @see.

PackageDoc

referencedPackage()

Return the package referenced by @see, or null if no known package found.

Method Detail

label

referencedClass

Return the class referenced by the class name part of @see, or null if the class is not a class specified on the SinjDoc command line.

referencedClassName

Return the class name part of @see. For example, if the comment is @see String#startsWith(java.lang.String), then this method returns "String". Returns null if format is not that of a java reference. Returns the empty string if the class name was not specified.

referencedMember

Return the member referenced by @see, or null if the member could not be determined or was not in the included set.

referencedMemberName

Return the name of the member referenced by @see. For example, if the comment is @see String#startsWith(java.lang.String), then this method returns "startsWith(java.lang.String)". Returns null if the format is not that of a java reference. Returns the empty string if the member name was not specified.

referencedPackage

Return the package referenced by @see, or null if no known package found.