org.exolab.javasource.JDocComment Class Reference

List of all members.

Public Member Functions
	JDocComment ()
void	addDescriptor (JDocDescriptor jdesc)
void	appendComment (String comment)
String	getComment ()
Enumeration	getDescriptors ()
int	getLength ()
JDocDescriptor	getParamDescriptor (String name)
void	print (JSourceWriter jsw)
void	setComment (String comment)
String	toString ()

---

Detailed Description

A class that "SOMEWHAT" represents a Java Doc Comment.

Author:

Keith Visco

Version:

Revision:

1.2

Date:

2003/03/08 07:30:52

---

Constructor & Destructor Documentation

org.exolab.javasource.JDocComment.JDocComment

(

)

Creates a new JavaDoc Comment

---

Member Function Documentation

void org.exolab.javasource.JDocComment.addDescriptor

(

JDocDescriptor

jdesc

)

Adds the given JDocDescriptor to this JDocComment

Parameters:

jdesc

the JDocDescriptor to add

References org.exolab.javasource.JDocDescriptor.compareTo().

Referenced by org.exolab.javasource.JMethodSignature.addParameter(), org.exolab.castor.builder.CollectionInfoJ2.createGetCollectionReferenceMethod(), org.exolab.castor.builder.CollectionInfo.createGetCollectionReferenceMethod(), org.exolab.castor.builder.FieldInfo.createGetterComment(), org.exolab.castor.builder.FieldInfo.createSetterComment(), org.exolab.javasource.JMethodSignature.JMethodSignature(), and org.exolab.javasource.JStructure.JStructure().

void org.exolab.javasource.JDocComment.appendComment

(

String

comment

)

Appends the comment String to this JDocComment

Parameters:

comment

the comment to append

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createGetCollectionReferenceMethod(), org.exolab.castor.builder.CollectionInfo.createGetCollectionReferenceMethod(), org.exolab.castor.builder.CollectionInfoJ2.createSetCollectionMethod(), org.exolab.castor.builder.CollectionInfo.createSetCollectionMethod(), org.exolab.castor.builder.CollectionInfoJ2.createSetCollectionReferenceMethod(), org.exolab.castor.builder.CollectionInfo.createSetCollectionReferenceMethod(), org.exolab.javasource.JAnnotationType.JAnnotationType(), org.exolab.javasource.JAnnotationTypeElement.JAnnotationTypeElement(), org.exolab.javasource.JClass.JClass(), org.exolab.javasource.JField.JField(), org.exolab.javasource.JInterface.JInterface(), and org.exolab.javasource.JMethod.JMethod().

String org.exolab.javasource.JDocComment.getComment

(

)

Returns the String value of this JDocComment.

Returns:

the String value of the JDocComment.

Enumeration org.exolab.javasource.JDocComment.getDescriptors

(

)

Returns an enumeration of the parameters of this JDocComment

Returns:

an enumeration of the parameters of this JDocComment

int org.exolab.javasource.JDocComment.getLength

(

)

Returns the length of the comment

Returns:

the length of the comment

JDocDescriptor org.exolab.javasource.JDocComment.getParamDescriptor

(

String

name

)

Returns the Parameter Descriptor associated with the given name

Returns:

the Parameter Descriptor associated with the given name

References org.exolab.javasource.JDocDescriptor.getName(), and org.exolab.javasource.JDocDescriptor.getType().

Referenced by org.exolab.castor.builder.CollectionInfoJ2.createSetCollectionMethod(), org.exolab.castor.builder.CollectionInfo.createSetCollectionMethod(), org.exolab.castor.builder.CollectionInfoJ2.createSetCollectionReferenceMethod(), org.exolab.castor.builder.CollectionInfo.createSetCollectionReferenceMethod(), and org.exolab.castor.builder.FieldInfo.createSetterComment().

void org.exolab.javasource.JDocComment.print

(

JSourceWriter

jsw

)

prints this JavaDoc comment using the given JSourceWriter

Parameters:

jsw

the JSourceWriter to print to

References org.exolab.javasource.JComment.appendComment(), org.exolab.javasource.JComment.print(), and org.exolab.javasource.JComment.setComment().

Referenced by org.exolab.javasource.JMethodSignature.print(), org.exolab.javasource.JMethod.print(), org.exolab.javasource.JInterface.print(), org.exolab.javasource.JClass.print(), org.exolab.javasource.JAnnotationTypeElement.print(), and org.exolab.javasource.JAnnotationType.print().

void org.exolab.javasource.JDocComment.setComment

(

String

comment

)

Sets the comment String of this JDocComment

Parameters:

comment

the comment String of this JDocComment

Referenced by org.exolab.castor.builder.FieldInfo.createGetterComment(), org.exolab.castor.builder.FieldInfo.createSetterComment(), org.exolab.castor.builder.SourceFactory.createSourceCode(), org.exolab.javasource.JMethodSignature.setComment(), org.exolab.javasource.JMethod.setComment(), and org.exolab.javasource.JAnnotationTypeElement.setComment().

String org.exolab.javasource.JDocComment.toString

(

)

Returns the String representation of this Java Doc Comment

Returns:

the String representation of this Java Doc Comment

---

The documentation for this class was generated from the following file:

• JDocComment.java