Package org.exolab.javasource
Class JDocComment
java.lang.Object
org.exolab.javasource.JDocComment
A class that "SOMEWHAT" represents a JavaDoc Comment.
- Version:
- $Revision$ $Date: 2005-02-26 17:30:28 -0700 (Sat, 26 Feb 2005) $
- Author:
- Keith Visco
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new JavaDoc Comment.JDocComment
(JDocDescriptor jdesc) Creates a new JavaDoc Comment and initializie it with given JDocDescriptor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDescriptor
(JDocDescriptor jdesc) Adds the given JDocDescriptor to this JDocComment.void
appendComment
(String comment) Appends the provided comment String to this JDocComment.Returns the String value of this JDocComment.Returns an Enumeration of the parameters of this JDocComment.int
Returns the length of the JavaDoc comment in characters.getParamDescriptor
(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
(String comment) Sets the comment String of this JDocComment.toString()
-
Constructor Details
-
JDocComment
public JDocComment()Creates a new JavaDoc Comment. -
JDocComment
Creates a new JavaDoc Comment and initializie it with given JDocDescriptor.- Parameters:
jdesc
- The JDocDescriptor to add.
-
-
Method Details
-
addDescriptor
Adds the given JDocDescriptor to this JDocComment.- Parameters:
jdesc
- The JDocDescriptor to add.
-
appendComment
Appends the provided comment String to this JDocComment.- Parameters:
comment
- The comment to append.
-
getComment
Returns the String value of this JDocComment.- Returns:
- The String value of this JDocComment.
-
setComment
Sets the comment String of this JDocComment.- Parameters:
comment
- The comment String of this JDocComment.
-
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
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
Prints this JavaDoc comment using the given JSourceWriter.- Parameters:
jsw
- The JSourceWriter to print to.
-
toString
-