Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.exolab.javasource.JDocComment
public final class JDocComment
extends java.lang.Object
Constructor Summary | |
| |
|
Method Summary | |
void |
|
void |
|
String |
|
Enumeration |
|
int |
|
JDocDescriptor |
|
void |
|
void |
|
String |
|
public JDocComment()
Creates a new JavaDoc Comment.
public JDocComment(JDocDescriptor jdesc)
Creates a new JavaDoc Comment and initializie it with given JDocDescriptor.
- Parameters:
jdesc
- The JDocDescriptor to add.
public void addDescriptor(JDocDescriptor jdesc)
Adds the given JDocDescriptor to this JDocComment.
- Parameters:
jdesc
- The JDocDescriptor to add.
public void appendComment(String comment)
Appends the provided comment String to this JDocComment.
- Parameters:
comment
- The comment to append.
public String getComment()
Returns the String value of this JDocComment.
- Returns:
- The String value of this JDocComment.
public Enumeration getDescriptors()
Returns an Enumeration of the parameters of this JDocComment.
- Returns:
- An Enumeration of the parameters of this JDocComment.
public int getLength()
Returns the length of the JavaDoc comment in characters.
- Returns:
- The length of the JavaDoc comment in characters.
public JDocDescriptor getParamDescriptor(String name)
Returns the Parameter Descriptor associated with the given name.
- Parameters:
name
- The name whose ParamDescriptor is being searched for.
- Returns:
- the Parameter Descriptor associated with the given name.
public void print(JSourceWriter jsw)
Prints this JavaDoc comment using the given JSourceWriter.
- Parameters:
jsw
- The JSourceWriter to print to.
public void setComment(String comment)
Sets the comment String of this JDocComment.
- Parameters:
comment
- The comment String of this JDocComment.
public String toString()