public final class JDocComment extends Object
Constructor and Description |
---|
JDocComment()
Creates a new JavaDoc Comment.
|
JDocComment(JDocDescriptor jdesc)
Creates a new JavaDoc Comment and initializie it with given JDocDescriptor.
|
Modifier and Type | Method and Description |
---|---|
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<JDocDescriptor> |
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() |
public JDocComment()
public JDocComment(JDocDescriptor jdesc)
jdesc
- The JDocDescriptor to add.public void addDescriptor(JDocDescriptor jdesc)
jdesc
- The JDocDescriptor to add.public void appendComment(String comment)
comment
- The comment to append.public String getComment()
public void setComment(String comment)
comment
- The comment String of this JDocComment.public Enumeration<JDocDescriptor> getDescriptors()
public int getLength()
public JDocDescriptor getParamDescriptor(String name)
name
- The name whose ParamDescriptor is being searched for.public void print(JSourceWriter jsw)
jsw
- The JSourceWriter to print to.Copyright © 2017. All rights reserved.