|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.modello.generator.java.javasource.JDocComment
A class that "SOMEWHAT" represents a Java Doc Comment.
Field Summary | |
private java.lang.StringBuffer |
_comment
The internal buffer for this JDocComment |
private java.util.Vector |
_descriptors
An ordered list of descriptors |
Constructor Summary | |
JDocComment()
Creates a new JavaDoc Comment |
Method Summary | |
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 |
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 |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
private java.util.Vector _descriptors
private java.lang.StringBuffer _comment
Constructor Detail |
public JDocComment()
Method Detail |
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 getDescriptors()
public int getLength()
public JDocDescriptor getParamDescriptor(java.lang.String name)
public 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()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |