com.combex.e.edoc
Class ESeeTag

java.lang.Object
  |
  +--com.combex.e.edoc.ETag
        |
        +--com.combex.e.edoc.ESeeTag

All Implemented Interfaces:

Marker, PassByConstruction, com.sun.javadoc.SeeTag, Serializable, com.sun.javadoc.Tag

class ESeeTag

extends ETag

implements com.sun.javadoc.SeeTag

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), Robert Field (rewrite), Atul M Dambalkar, mods by Mark Miller of combex.com subject to the terms of Sun's SCSL license.

Field Summary

(package private) EDoc	myHolder
private String	myLabel
(package private) String	myName
private EClassDoc	myReferencedClass
private EMemberDoc	myReferencedMember
private EPackageDoc	myReferencedPackage
(package private) String	myText
private String	myWhat what of where#what - i.e.
private String	myWhere where of where#what - i.e.

Fields inherited from interface org.erights.e.elib.serial.PassByConstruction

HONORARY, HONORED_NAMES, serialVersionUID

Constructor Summary

(package private)

ESeeTag(EDoc holder, String name, String text)

Method Summary

(package private) String[]	divideAtWhite() for use by subclasses which have two part tag text.
private EMemberDoc	findExecutableMember(String memName, String[] paramarr, com.sun.javadoc.ClassDoc referencedClass)
private void	findReferenced(com.sun.javadoc.Doc holder, EClassDoc containingClass) Find what is referenced by the see also.
private com.sun.javadoc.MemberDoc	findReferencedMethod(String memName, String[] paramarr, com.sun.javadoc.ClassDoc referencedClass)
com.sun.javadoc.Tag[]	firstSentenceTags() Return array of tags for the first sentence in the doc comment text.
com.sun.javadoc.Tag[]	inlineTags() For documentation comment with embedded @link tags, return the array of TagImpls consisting of ESeeTag(s) and text containing ETag(s).
String	kind() Return the kind of this tag.
String	label() Return the label of the see tag.
String	name() Return the name of this tag.
private void	parseSeeString(com.sun.javadoc.Doc holder) parse @see part of comment.
com.sun.javadoc.SourcePosition	position() Need for 1.4
String	qualifiedDocName() Return the qualified name of this tags' doc item.
com.sun.javadoc.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) .
String	referencedClassName() get the class name part of @see, For instance, if the comment is @see String#startsWith(java.lang.String) .
com.sun.javadoc.MemberDoc	referencedMember() get the member referenced by the prototype part of @see, For instance, if the comment is @see String#startsWith(java.lang.String) .
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) .
com.sun.javadoc.PackageDoc	referencedPackage() get the package referenced by @see.
String	text() Return the text of this tag, that is, portion beyond tag name.
String	toString() convert this object to a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

myWhere

private String myWhere

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

myWhat

private String myWhat

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

myReferencedPackage

private final EPackageDoc myReferencedPackage

myReferencedClass

private EClassDoc myReferencedClass

myReferencedMember

private EMemberDoc myReferencedMember

myLabel

private String myLabel

myText

final String myText

myName

final String myName

myHolder

final EDoc myHolder

Constructor Detail

ESeeTag

ESeeTag(EDoc holder,
        String name,
        String text)

Method Detail

referencedClassName

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

referencedPackage

public com.sun.javadoc.PackageDoc referencedPackage()

get the package referenced by @see. For instance, if the comment is @see java.lang This function returns a EPackageDoc for java.lang Returns null if no known package found.

XXX Bug: Currently, in edoc, this will always return null.

referencedClass

public com.sun.javadoc.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 EClassDoc for java.lang.String. Returns null if class is not a class specified on the javadoc command line..

referencedMemberName

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) . 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 com.sun.javadoc.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 EMethodDoc for startsWith. Returns null if member could not be determined.

parseSeeString

private void parseSeeString(com.sun.javadoc.Doc holder)

parse @see part of comment. Determine 'where' and 'what'

findReferenced

private void findReferenced(com.sun.javadoc.Doc holder,
                            EClassDoc containingClass)

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 com.sun.javadoc.MemberDoc findReferencedMethod(String memName,
                                                       String[] paramarr,
                                                       com.sun.javadoc.ClassDoc referencedClass)

findExecutableMember

private EMemberDoc findExecutableMember(String memName,
                                        String[] paramarr,
                                        com.sun.javadoc.ClassDoc referencedClass)

kind

public String kind()

Return the kind of this tag.

Overrides:

kind in class ETag

label

public String label()

Return the label of the see tag.

name

public String name()

Return the name of this tag.

text

public String text()

Return the text of this tag, that is, portion beyond tag name.

divideAtWhite

String[] divideAtWhite()

for use by subclasses which have two part tag text.

toString

public String toString()

convert this object to a string.

Overrides:

toString in class Object

Returns:

a string representation of the object.

inlineTags

public com.sun.javadoc.Tag[] inlineTags()

For documentation comment with embedded @link tags, return the array of TagImpls consisting of ESeeTag(s) and text containing ETag(s). Within a comment string "This is an example of inline tags for a documentaion comment commentlabel", where inside the inner braces, the first "Doc" carries exctly the same syntax as a ESeeTag and the second "commentlabel" is label for the Html Link, will return an array of ETag(s) with first element as ETag with comment text "This is an example of inline tags for a documentation comment" and second element as ESeeTag with referenced class as "Doc" and the label for the Html Link as "commentlabel".

Returns:

ETag[] Array of tags with inline SeeTagImpls.

See Also:

EParamTag, EThrowsTag

firstSentenceTags

public com.sun.javadoc.Tag[] firstSentenceTags()

Return array of tags for the first sentence in the doc comment text.

qualifiedDocName

public String qualifiedDocName()

Return the qualified name of this tags' doc item.

position

public com.sun.javadoc.SourcePosition position()

Need for 1.4