org.exolab.javasource
public class JDocComment extends Object
Version: $Revision: 1.2 $ $Date: 2003/03/08 07:30:52 $
Constructor Summary | |
---|---|
JDocComment()
Creates a new JavaDoc Comment |
Method Summary | |
---|---|
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
|
Parameters: jdesc the JDocDescriptor to add
Parameters: comment the comment to append
Returns: the String value of the JDocComment.
Returns: an enumeration of the parameters of this JDocComment
Returns: the length of the comment
Returns: the Parameter Descriptor associated with the given name
Parameters: jsw the JSourceWriter to print to
Parameters: comment the comment String of this JDocComment
Returns: the String representation of this Java Doc Comment