net.kldp.jcodegen.base
Class MethodJavaDocComment

java.lang.Object
  extended by net.kldp.jcodegen.base.AbstractBlockComment
      extended by net.kldp.jcodegen.base.MethodJavaDocComment
All Implemented Interfaces:
Comment, Source

public class MethodJavaDocComment
extends AbstractBlockComment

represent javadoc comment.


Constructor Summary
MethodJavaDocComment(ParamHolder paramHolder)
           
 
Method Summary
 void addTagComment(java.lang.String tagName, java.lang.String comment)
           
 void addThrowsComment(java.lang.Class type, java.lang.String comment)
           
 void addThrowsComment(java.lang.String simpleTypeName, java.lang.String comment)
           
protected  void appendBody(int level, Output target, Formatter formatter)
           
protected  void appendHeader(int level, Output target, Formatter formatter)
          add block comment header
protected  void appendTail(int level, Output target, Formatter formatter)
           
 boolean isEmpty()
           
 void setReturnComment(java.lang.String comment)
           
 
Methods inherited from class net.kldp.jcodegen.base.AbstractBlockComment
addCommentLine, appendContents, getBodyStartString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MethodJavaDocComment

public MethodJavaDocComment(ParamHolder paramHolder)
Method Detail

appendHeader

protected void appendHeader(int level,
                            Output target,
                            Formatter formatter)
Description copied from class: AbstractBlockComment
add block comment header

Specified by:
appendHeader in class AbstractBlockComment

appendTail

protected void appendTail(int level,
                          Output target,
                          Formatter formatter)
Specified by:
appendTail in class AbstractBlockComment

appendBody

protected void appendBody(int level,
                          Output target,
                          Formatter formatter)
Overrides:
appendBody in class AbstractBlockComment

isEmpty

public boolean isEmpty()
Overrides:
isEmpty in class AbstractBlockComment

addThrowsComment

public void addThrowsComment(java.lang.String simpleTypeName,
                             java.lang.String comment)

addThrowsComment

public void addThrowsComment(java.lang.Class type,
                             java.lang.String comment)

setReturnComment

public void setReturnComment(java.lang.String comment)

addTagComment

public void addTagComment(java.lang.String tagName,
                          java.lang.String comment)