com.sun.codemodel
Class JDocComment

java.lang.Object
  extended by com.sun.codemodel.JDocComment

public class JDocComment
extends java.lang.Object

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

JDocComment

public JDocComment()
Method Detail

getComment

public java.lang.String getComment()
Gets the body of the comment.


setComment

public JDocComment setComment(java.lang.String comment)
Sets the body of the comment.


appendComment

public JDocComment appendComment(java.lang.String comment)
Appends text to the body of the comment.


addParam

public JDocComment addParam(java.lang.String param,
                            java.lang.String comment)
add an @param tag to the javadoc


addParam

public JDocComment addParam(JVar param,
                            java.lang.String comment)
add an @param tag to the javadoc


addThrows

public JDocComment addThrows(java.lang.String exception,
                             java.lang.String comment)
add an @throws tag to the javadoc


addThrows

public JDocComment addThrows(java.lang.Class exception,
                             java.lang.String comment)
add an @throws tag to the javadoc


addThrows

public JDocComment addThrows(JClass exception,
                             java.lang.String comment)
add an @throws tag to the javadoc


addReturn

public JDocComment addReturn(java.lang.String comment)
add an @return tag to the javadoc


setDeprecated

public void setDeprecated(java.lang.String comment)
add an @deprecated tag to the javadoc, with the associated message.


addXDoclet

public JXDoclet addXDoclet(java.lang.String name)
add an xdoclet tag to the javadoc


generate

public void generate(JFormatter f)