org.exolab.javasource
Class JDocComment
java.lang.Object
org.exolab.javasource.JDocComment
public class JDocComment
extends java.lang.Object
A class that "SOMEWHAT" represents a Java Doc Comment.
$Revision: 1.2 $ $Date: 2003/03/08 07:30:52 $
void | addDescriptor(JDocDescriptor jdesc) - Adds the given JDocDescriptor to this JDocComment
|
void | appendComment(String comment) - Appends the comment String to this JDocComment
|
String | getComment() - Returns the String value of this JDocComment.
|
Enumeration | getDescriptors() - Returns an enumeration of the parameters of this JDocComment
|
int | getLength() - Returns the length of the comment
|
JDocDescriptor | getParamDescriptor(String name) - Returns the Parameter Descriptor associated with the
given name
|
void | print(JSourceWriter jsw) - prints this JavaDoc comment using the given JSourceWriter
|
void | setComment(String comment) - Sets the comment String of this JDocComment
|
String | toString() - Returns the String representation of this Java Doc Comment
|
JDocComment
public JDocComment()
Creates a new JavaDoc Comment
addDescriptor
public void addDescriptor(JDocDescriptor jdesc)
Adds the given JDocDescriptor to this JDocComment
jdesc
- the JDocDescriptor to add
appendComment
public void appendComment(String comment)
Appends the comment String to this JDocComment
comment
- the comment to append
getComment
public String getComment()
Returns the String value of this JDocComment.
- the String value of the JDocComment.
getDescriptors
public Enumeration getDescriptors()
Returns an enumeration of the parameters of this JDocComment
- an enumeration of the parameters of this JDocComment
getLength
public int getLength()
Returns the length of the comment
- the length of the comment
getParamDescriptor
public JDocDescriptor getParamDescriptor(String name)
Returns the Parameter Descriptor associated with the
given name
- the Parameter Descriptor associated with the
given name
print
public void print(JSourceWriter jsw)
prints this JavaDoc comment using the given JSourceWriter
jsw
- the JSourceWriter to print to
setComment
public void setComment(String comment)
Sets the comment String of this JDocComment
comment
- the comment String of this JDocComment
toString
public String toString()
Returns the String representation of this Java Doc Comment
- the String representation of this Java Doc Comment
Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com