public class JDocComment extends Object
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(String comment)
Appends the comment String to this JDocComment
|
String |
getComment()
Returns the String value of this JDocComment.
|
Enumeration<JDocDescriptor> |
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
|
public void addDescriptor(JDocDescriptor jdesc)
jdesc
- the JDocDescriptor to addpublic void appendComment(String comment)
comment
- the comment to appendpublic String getComment()
public Enumeration<JDocDescriptor> getDescriptors()
public int getLength()
public JDocDescriptor getParamDescriptor(String name)
public void print(JSourceWriter jsw)
jsw
- the JSourceWriter to print topublic void setComment(String comment)
comment
- the comment String of this JDocCommentCopyright © 2001-2019 Codehaus. All Rights Reserved.