public class JDocComment
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
private java.lang.StringBuilder |
_comment
The internal buffer for this JDocComment
|
private java.util.List<JDocDescriptor> |
_descriptors
An ordered list of descriptors
|
Constructor and Description |
---|
JDocComment()
Creates a new JavaDoc Comment
|
Modifier and Type | Method and Description |
---|---|
void |
addDescriptor(JDocDescriptor jdesc)
Adds the given JDocDescriptor to this JDocComment
|
void |
appendComment(java.lang.String comment)
Appends the comment String to this JDocComment
|
java.lang.String |
getComment()
Returns the String value of this JDocComment.
|
java.util.Enumeration<JDocDescriptor> |
getDescriptors()
Returns an enumeration of the parameters of this JDocComment
|
int |
getLength()
Returns the length of the comment
|
JDocDescriptor |
getParamDescriptor(java.lang.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(java.lang.String comment)
Sets the comment String of this JDocComment
|
java.lang.String |
toString()
Returns the String representation of this Java Doc Comment
|
private java.util.List<JDocDescriptor> _descriptors
private java.lang.StringBuilder _comment
public void addDescriptor(JDocDescriptor jdesc)
jdesc
- the JDocDescriptor to addpublic void appendComment(java.lang.String comment)
comment
- the comment to appendpublic java.lang.String getComment()
public java.util.Enumeration<JDocDescriptor> getDescriptors()
public int getLength()
public JDocDescriptor getParamDescriptor(java.lang.String name)
name
- the name of the parameterpublic void print(JSourceWriter jsw)
jsw
- the JSourceWriter to print topublic void setComment(java.lang.String comment)
comment
- the comment String of this JDocCommentpublic java.lang.String toString()
toString
in class java.lang.Object