com.combex.e.edoc
Class EParamTag

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

All Implemented Interfaces:

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

class EParamTag

extends ETag

implements com.sun.javadoc.ParamTag

Represents an @param documentation tag. The parses and stores the name and comment parts of the method/constructor parameter tag.

Author:

Robert Field, mods by Mark Miller of combex.com subject to the terms of Sun's SCSL license.

Field Summary

(package private) EDoc	myHolder
(package private) String	myName
private String	myParameterComment
private String	myParameterName
(package private) String	myText

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

HONORARY, HONORED_NAMES, serialVersionUID

Constructor Summary

(package private)

EParamTag(EDoc holder, String name, String text)

Method Summary

(package private) String[]	divideAtWhite() for use by subclasses which have two part tag text.
com.sun.javadoc.Tag[]	firstSentenceTags() Return array of tags for the first sentence in the doc comment text.
com.sun.javadoc.Tag[]	inlineTags() For the parameter 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	name() Return the name of this tag.
String	parameterComment() Return the parameter comment.
String	parameterName() Return the parameter name.
com.sun.javadoc.SourcePosition	position() Need for 1.4
String	qualifiedDocName() Return the qualified name of this tags' doc item.
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

myParameterName

private final String myParameterName

myParameterComment

private final String myParameterComment

myText

final String myText

myName

final String myName

myHolder

final EDoc myHolder

Constructor Detail

EParamTag

EParamTag(EDoc holder,
          String name,
          String text)

Method Detail

parameterName

public String parameterName()

Return the parameter name.

parameterComment

public String parameterComment()

Return the parameter comment.

kind

public String kind()

Return the kind of this tag.

Overrides:

kind in class ETag

toString

public String toString()

convert this object to a string.

Overrides:

toString in class ETag

Returns:

a string representation of the object.

inlineTags

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

For the parameter comment with embedded @link tags return the array of TagImpls consisting of ESeeTag(s) and text containing ETag(s).

Overrides:

inlineTags in class ETag

Returns:

ETag[] Array of tags with inline SeeTagImpls.

See Also:

ETag#inlineTagImpls(), ThrowsTagImpl#inlineTagImpls()

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.

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