|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.codemodel.JDocComment
public class JDocComment
JavaDoc comment. TODO: it would be nice if we have JComment class and we can derive this class from there.
Constructor Summary | |
---|---|
JDocComment()
|
Method Summary | |
---|---|
JDocComment |
addParam(JVar param,
java.lang.String comment)
add an @param tag to the javadoc |
JDocComment |
addParam(java.lang.String param,
java.lang.String comment)
add an @param tag to the javadoc |
JDocComment |
addReturn(java.lang.String comment)
add an @return tag to the javadoc |
JDocComment |
addThrows(java.lang.Class exception,
java.lang.String comment)
add an @throws tag to the javadoc |
JDocComment |
addThrows(JClass exception,
java.lang.String comment)
add an @throws tag to the javadoc |
JDocComment |
addThrows(java.lang.String exception,
java.lang.String comment)
add an @throws tag to the javadoc |
JXDoclet |
addXDoclet(java.lang.String name)
add an xdoclet tag to the javadoc |
JDocComment |
appendComment(java.lang.String comment)
Appends text to the body of the comment. |
void |
generate(JFormatter f)
|
java.lang.String |
getComment()
Gets the body of the comment. |
JDocComment |
setComment(java.lang.String comment)
Sets the body of the comment. |
void |
setDeprecated(java.lang.String comment)
add an @deprecated tag to the javadoc, with the associated message. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JDocComment()
Method Detail |
---|
public java.lang.String getComment()
public JDocComment setComment(java.lang.String comment)
public JDocComment appendComment(java.lang.String comment)
public JDocComment addParam(java.lang.String param, java.lang.String comment)
public JDocComment addParam(JVar param, java.lang.String comment)
public JDocComment addThrows(java.lang.String exception, java.lang.String comment)
public JDocComment addThrows(java.lang.Class exception, java.lang.String comment)
public JDocComment addThrows(JClass exception, java.lang.String comment)
public JDocComment addReturn(java.lang.String comment)
public void setDeprecated(java.lang.String comment)
public JXDoclet addXDoclet(java.lang.String name)
public void generate(JFormatter f)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |