com.sun.codemodel
public class JDocComment extends JCommentPart
A javadoc comment consists of multiple parts. There's the main part (that comes the first in in the comment section), then the parameter parts (@param), the return part (@return), and the throws parts (@throws). TODO: it would be nice if we have JComment class and we can derive this class from there.
Constructor and Description |
---|
JDocComment(JCodeModel owner) |
Modifier and Type | Method and Description |
---|---|
JCommentPart |
addDeprecated()
add an @deprecated tag to the javadoc, with the associated message.
|
JCommentPart |
addParam(JVar param)
Append a text to an @param tag.
|
JCommentPart |
addParam(java.lang.String param)
Append a text to a @param tag to the javadoc
|
JCommentPart |
addReturn()
Appends a text to @return tag.
|
JCommentPart |
addThrows(java.lang.Class exception)
add an @throws tag to the javadoc
|
JCommentPart |
addThrows(JClass exception)
add an @throws tag to the javadoc
|
java.util.Map<java.lang.String,java.lang.String> |
addXdoclet(java.lang.String name)
add an xdoclet.
|
java.util.Map<java.lang.String,java.lang.String> |
addXdoclet(java.lang.String name,
java.util.Map<java.lang.String,java.lang.String> attributes)
add an xdoclet.
|
java.util.Map<java.lang.String,java.lang.String> |
addXdoclet(java.lang.String name,
java.lang.String attribute,
java.lang.String value)
add an xdoclet.
|
JDocComment |
append(java.lang.Object o)
Appends a new value.
|
void |
generate(JFormatter f) |
add, format
add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeRange, retainAll, set, size, subList, toArray, toArray, trimToSize
public JDocComment(JCodeModel owner)
public JDocComment append(java.lang.Object o)
JCommentPart
JType
it will be printed as a @link tag.
Otherwise it will be converted to String via Object.toString()
.append
in class JCommentPart
public JCommentPart addParam(java.lang.String param)
public JCommentPart addParam(JVar param)
public JCommentPart addThrows(java.lang.Class exception)
public JCommentPart addThrows(JClass exception)
public JCommentPart addReturn()
public JCommentPart addDeprecated()
public java.util.Map<java.lang.String,java.lang.String> addXdoclet(java.lang.String name)
public java.util.Map<java.lang.String,java.lang.String> addXdoclet(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> attributes)
public java.util.Map<java.lang.String,java.lang.String> addXdoclet(java.lang.String name, java.lang.String attribute, java.lang.String value)
public void generate(JFormatter f)
Copyright © 2005-2014 Sun Microsystems. All Rights Reserved.