Class JDocComment


  • public final class JDocComment
    extends java.lang.Object
    A class that "SOMEWHAT" represents a JavaDoc Comment.
    Version:
    $Revision: 7943 $ $Date: 2005-02-26 17:30:28 -0700 (Sat, 26 Feb 2005) $
    Author:
    Keith Visco
    • Constructor Summary

      Constructors 
      Constructor Description
      JDocComment()
      Creates a new JavaDoc Comment.
      JDocComment​(JDocDescriptor jdesc)
      Creates a new JavaDoc Comment and initializie it with given JDocDescriptor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addDescriptor​(JDocDescriptor jdesc)
      Adds the given JDocDescriptor to this JDocComment.
      void appendComment​(java.lang.String comment)
      Appends the provided comment String to this JDocComment.
      java.lang.String getComment()
      Returns the String value of this JDocComment.
      java.util.Enumeration<JDocDescriptor> getDescriptors()
      Returns an Enumeration of the parameters of this JDocComment.
      int getLength()
      Returns the length of the JavaDoc comment in characters.
      JDocDescriptor getParamDescriptor​(java.lang.String name)
      Returns the Parameter Descriptor associated with the given name.
      void print​(JSourceWriter jsw)
      Prints this JavaDoc comment using the given JSourceWriter.
      void setComment​(java.lang.String comment)
      Sets the comment String of this JDocComment.
      java.lang.String toString()
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • JDocComment

        public JDocComment()
        Creates a new JavaDoc Comment.
      • JDocComment

        public JDocComment​(JDocDescriptor jdesc)
        Creates a new JavaDoc Comment and initializie it with given JDocDescriptor.
        Parameters:
        jdesc - The JDocDescriptor to add.
    • Method Detail

      • addDescriptor

        public void addDescriptor​(JDocDescriptor jdesc)
        Adds the given JDocDescriptor to this JDocComment.
        Parameters:
        jdesc - The JDocDescriptor to add.
      • appendComment

        public void appendComment​(java.lang.String comment)
        Appends the provided comment String to this JDocComment.
        Parameters:
        comment - The comment to append.
      • getComment

        public java.lang.String getComment()
        Returns the String value of this JDocComment.
        Returns:
        The String value of this JDocComment.
      • setComment

        public void setComment​(java.lang.String comment)
        Sets the comment String of this JDocComment.
        Parameters:
        comment - The comment String of this JDocComment.
      • getDescriptors

        public java.util.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 JavaDoc comment in characters.
        Returns:
        The length of the JavaDoc comment in characters.
      • getParamDescriptor

        public JDocDescriptor getParamDescriptor​(java.lang.String name)
        Returns the Parameter Descriptor associated with the given name.
        Parameters:
        name - The name whose ParamDescriptor is being searched for.
        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.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object