org.apache.ws.jaxme.js
public class JavaComment extends Object
A class representing a Java comment.
Method Summary | |
---|---|
void | addAuthor(String author) Sets the JavaDoc author field. |
void | addLine(String s) Adds a line to the comments content. |
void | addParam(String s) Adds a JavaDoc "param" field. |
void | addSee(String pSee) Adds an element to the list of Strings which should be used for "see" fields. |
void | addThrows(String s) Adds a JavaDoc "throw" field. |
List | getAuthors() Returns the JavaDoc author field or null, if there is no author field. |
ArrayList | getLines() Returns an array of lines being the comments content. |
List | getParams() Returns an array of values for the JavaDoc param field. |
String | getReturn() Returns the JavaDoc return field or null, if there is no return field. |
List | getSee() Returns an array list of Strings which should be used for "see" fields. |
List | getThrows() Returns an array of values for the JavaDoc throw field. |
String | getVersion() Returns the JavaDoc version field or null, if there is no version field. |
void | setReturn(String pReturns) Sets the JavaDoc return field. |
void | setVersion(String pVersion) Sets the JavaDoc version field. |
void | write(IndentationTarget pTarget) Returns a string representation of this comment. |
Sets the JavaDoc author field. Use null to disable the author field.
See Also: JavaComment
Adds a line to the comments content.
See Also: JavaComment
Adds a JavaDoc "param" field.
See Also: JavaComment
Adds an element to the list of Strings which should be used for "see" fields.
See Also: JavaComment
Adds a JavaDoc "throw" field.
See Also: JavaComment
Returns the JavaDoc author field or null, if there is no author field.
See Also: JavaComment
Returns an array of lines being the comments content.
See Also: JavaComment
Returns an array of values for the JavaDoc param field.
See Also: JavaComment
Returns the JavaDoc return field or null, if there is no return field.
See Also: JavaComment
Returns an array list of Strings which should be used for "see" fields.
See Also: JavaComment
Returns an array of values for the JavaDoc throw field.
See Also: JavaComment
Returns the JavaDoc version field or null, if there is no version field.
See Also: JavaComment
Sets the JavaDoc return field. Use null to disable the return field.
See Also: JavaComment
Sets the JavaDoc version field. Use null to disable the version field.
See Also: JavaComment
Returns a string representation of this comment.