org.exolab.javasource
public final class JComment extends Object
Version: $Revision: 6324 $ $Date: 2005-02-26 17:30:28 -0700 (Sat, 26 Feb 2005) $
Field Summary | |
---|---|
static short | AUTO_STYLE
The auto style, allows this JComment to automatically choose a style for
this comment. |
static short | BLOCK_STYLE
The block comment style. |
static short | HEADER_STYLE
The header style, similiar to block, but with an '*' at the start of each
line. |
static short | JAVADOC_STYLE
Similiar to HEADER_STYLE. |
static short | LINE_STYLE
The line comment style. |
protected static int | MAX_LENGTH
The maximum number of characters per line. |
Constructor Summary | |
---|---|
JComment()
Creates a new Java Comment. | |
JComment(short style)
Creates a new Java comment with the given style. |
Method Summary | |
---|---|
void | appendComment(String comment)
Appends the comment String to this JDocComment.
|
void | print(JSourceWriter jsw)
Prints this JComment using the given JSourceWriter.
|
void | setComment(String comment)
Sets the comment String of this JDocComment.
|
void | setStyle(short style)
Sets the style for this JComment.
|
String | toString()
Returns the String representation of this Java Doc Comment.
|
Parameters: style the desired style
Parameters: comment the comment to append
Parameters: jsw the JSourceWriter to print to
Parameters: comment the comment String of this JDocComment
Parameters: style the style to use for this JComment
Returns: the String representation of this Java Doc Comment.