org.exolab.javasource
public final class JDocComment extends Object
Version: $Revision: 6324 $ $Date: 2005-02-26 17:30:28 -0700 (Sat, 26 Feb 2005) $
| 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 provided 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 JavaDoc comment in characters.
|
| 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 JavaDoc comment.
|
Parameters: jdesc the JDocDescriptor to add
Parameters: comment the comment to append
Returns: the String value of this JDocComment.
Returns: an Enumeration of the parameters of this JDocComment.
Returns: the length of the JavaDoc comment in characters.
Parameters: name the name whose ParamDescriptor is being searched for
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 JavaDoc comment.