Package | Description |
---|---|
org.jboss.jdeparser |
Modifier and Type | Class and Description |
---|---|
class |
JDocComment
JavaDoc comment.
|
Modifier and Type | Field and Description |
---|---|
private JCommentPart |
JDocComment.atDeprecated
The @deprecated tag
|
private JCommentPart |
JDocComment.atReturn
The @return tag part.
|
Modifier and Type | Field and Description |
---|---|
private java.util.Map<java.lang.String,JCommentPart> |
JDocComment.atParams
list of @param tags
|
private java.util.Map<JClass,JCommentPart> |
JDocComment.atThrows
list of @throws tags
|
Modifier and Type | Method and Description |
---|---|
JCommentPart |
JDocComment.addDeprecated()
add an @deprecated tag to the javadoc, with the associated message.
|
JCommentPart |
JDocComment.addParam(JVar param)
Append a text to an @param tag.
|
JCommentPart |
JDocComment.addParam(java.lang.String param)
Append a text to a @param tag to the javadoc
|
JCommentPart |
JDocComment.addReturn()
Appends a text to @return tag.
|
JCommentPart |
JDocComment.addThrows(java.lang.Class<? extends java.lang.Throwable> exception)
add an @throws tag to the javadoc
|
JCommentPart |
JDocComment.addThrows(JClass exception)
add an @throws tag to the javadoc
|
JCommentPart |
JCommentPart.append(java.lang.Object o)
Appends a new value.
|