Class JDocComment
java.lang.Object
org.codehaus.modello.plugin.java.javasource.JDocComment
A class that "SOMEWHAT" represents a Java Doc Comment.
- Version:
- $Revision$ $Date$
- Author:
- Keith Visco
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addDescriptor
(JDocDescriptor jdesc) Adds the given JDocDescriptor to this JDocCommentvoid
appendComment
(String comment) Appends the comment String to this JDocCommentReturns the String value of this JDocComment.Returns an enumeration of the parameters of this JDocCommentint
Returns the length of the commentgetParamDescriptor
(String name) Returns the Parameter Descriptor associated with the given namevoid
print
(JSourceWriter jsw) prints this JavaDoc comment using the given JSourceWritervoid
setComment
(String comment) Sets the comment String of this JDocCommenttoString()
Returns the String representation of this Java Doc Comment
-
Constructor Details
-
JDocComment
public JDocComment()Creates a new JavaDoc Comment
-
-
Method Details
-
addDescriptor
Adds the given JDocDescriptor to this JDocComment- Parameters:
jdesc
- the JDocDescriptor to add
-
appendComment
Appends the comment String to this JDocComment- Parameters:
comment
- the comment to append
-
getComment
Returns the String value of this JDocComment.- Returns:
- the String value of the 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 comment- Returns:
- the length of the comment
-
getParamDescriptor
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
prints this JavaDoc comment using the given JSourceWriter- Parameters:
jsw
- the JSourceWriter to print to
-
setComment
Sets the comment String of this JDocComment- Parameters:
comment
- the comment String of this JDocComment
-
toString
Returns the String representation of this Java Doc Comment
-