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