Package org.codehaus.modello.plugin.java.javasource

Class JDocComment

java.lang.Object
org.codehaus.modello.plugin.java.javasource.JDocComment
public class JDocComment extends Object
A class that "SOMEWHAT" represents a Java Doc Comment.
Version:
$Revision$ $Date$
Author:
Keith Visco

  • Constructor Details

    • JDocComment

      public JDocComment()
      Creates a new JavaDoc Comment

  • Method Details

    • addDescriptor

      public void addDescriptor(JDocDescriptor jdesc)
      Adds the given JDocDescriptor to this JDocComment
      Parameters:
      jdesc - the JDocDescriptor to add

    • appendComment

      public void appendComment(String comment)
      Appends the comment String to this JDocComment
      Parameters:
      comment - the comment to append

    • getComment

      public String getComment()
      Returns the String value of this JDocComment.
      Returns:
      the String value of the JDocComment.

    • getDescriptors

      public Enumeration<JDocDescriptor> getDescriptors()
      Returns an enumeration of the parameters of this JDocComment
      Returns:
      an enumeration of the parameters of this JDocComment

    • getLength

      public int getLength()
      Returns the length of the comment
      Returns:
      the length of the comment

    • getParamDescriptor

      public JDocDescriptor getParamDescriptor(String name)
      Returns the Parameter Descriptor associated with the given name
      Parameters:
      name - the name of the parameter
      Returns:
      the Parameter Descriptor associated with the given name

    • print

      public void print(JSourceWriter jsw)
      prints this JavaDoc comment using the given JSourceWriter
      Parameters:
      jsw - the JSourceWriter to print to

    • setComment

      public void setComment(String comment)
      Sets the comment String of this JDocComment
      Parameters:
      comment - the comment String of this JDocComment

    • toString

      public String toString()
      Returns the String representation of this Java Doc Comment
      Overrides:
      toString in class Object
      Returns:
      the String representation of this Java Doc Comment