|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractList<E>
java.util.ArrayList<Object>
com.sun.codemodel.JCommentPart
com.sun.codemodel.JDocComment
public class JDocComment
JavaDoc comment.
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.
| Field Summary |
|---|
| Fields inherited from class java.util.AbstractList |
|---|
modCount |
| Constructor Summary | |
|---|---|
JDocComment(JCodeModel owner)
|
|
| Method Summary | |
|---|---|
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(String param)
Append a text to a @param tag to the javadoc |
JCommentPart |
addReturn()
Appends a text to @return tag. |
JCommentPart |
addThrows(Class<? extends Throwable> exception)
add an @throws tag to the javadoc |
JCommentPart |
addThrows(JClass exception)
add an @throws tag to the javadoc |
Map<String,String> |
addXdoclet(String name)
add an xdoclet. |
Map<String,String> |
addXdoclet(String name,
Map<String,String> attributes)
add an xdoclet. |
Map<String,String> |
addXdoclet(String name,
String attribute,
String value)
add an xdoclet. |
JDocComment |
append(Object o)
Appends a new value. |
void |
generate(JFormatter f)
|
| Methods inherited from class com.sun.codemodel.JCommentPart |
|---|
add, format |
| Methods inherited from class java.util.ArrayList |
|---|
add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, removeRange, set, size, toArray, toArray, trimToSize |
| Methods inherited from class java.util.AbstractList |
|---|
equals, hashCode, iterator, listIterator, listIterator, subList |
| Methods inherited from class java.util.AbstractCollection |
|---|
containsAll, removeAll, retainAll, toString |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface java.util.List |
|---|
containsAll, equals, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList |
| Constructor Detail |
|---|
public JDocComment(JCodeModel owner)
| Method Detail |
|---|
public JDocComment append(Object o)
JCommentPartJType it will be printed as a @link tag.
Otherwise it will be converted to String via Object.toString().
append in class JCommentPartpublic JCommentPart addParam(String param)
public JCommentPart addParam(JVar param)
public JCommentPart addThrows(Class<? extends Throwable> exception)
public JCommentPart addThrows(JClass exception)
public JCommentPart addReturn()
public JCommentPart addDeprecated()
public Map<String,String> addXdoclet(String name)
public Map<String,String> addXdoclet(String name,
Map<String,String> attributes)
public Map<String,String> addXdoclet(String name,
String attribute,
String value)
public void generate(JFormatter f)
generate in interface JGenerable
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||