|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exolab.javasource.JDocComment
public final class JDocComment
A class that "SOMEWHAT" represents a JavaDoc Comment.
Constructor Summary | |
---|---|
JDocComment()
Creates a new JavaDoc Comment. |
|
JDocComment(JDocDescriptor jdesc)
Creates a new JavaDoc Comment and initializie it with given JDocDescriptor. |
Method Summary | |
---|---|
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 |
---|
public JDocComment()
public JDocComment(JDocDescriptor jdesc)
jdesc
- The JDocDescriptor to add.Method Detail |
---|
public void addDescriptor(JDocDescriptor jdesc)
jdesc
- The JDocDescriptor to add.public void appendComment(java.lang.String comment)
comment
- The comment to append.public java.lang.String getComment()
public void setComment(java.lang.String comment)
comment
- The comment String of this JDocComment.public java.util.Enumeration<JDocDescriptor> getDescriptors()
public int getLength()
public JDocDescriptor getParamDescriptor(java.lang.String name)
name
- The name whose ParamDescriptor is being searched for.
public void print(JSourceWriter jsw)
jsw
- The JSourceWriter to print to.public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |