Package com.sun.codemodel
Class JDocComment
- All Implemented Interfaces:
JGenerable
,Serializable
,Cloneable
,Iterable<Object>
,Collection<Object>
,List<Object>
,RandomAccess
,SequencedCollection<Object>
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.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate JCommentPart
The @deprecated tagprivate final Map
<String, JCommentPart> list of @param tagsprivate JCommentPart
The @return tag part.private final Map
<JClass, JCommentPart> list of @throws tagslist of xdocletsprivate static final String
private final JCodeModel
private static final long
Fields inherited from class java.util.AbstractList
modCount
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionadd an @deprecated tag to the javadoc, with the associated message.Append a text to an @param tag.Append a text to a @param tag to the javadocAppends a text to @return tag.add an @throws tag to the javadocadd an @throws tag to the javadocaddXdoclet
(String name) add an xdoclet.addXdoclet
(String name, String attribute, String value) add an xdoclet.addXdoclet
(String name, Map<String, String> attributes) add an xdoclet.Appends a new value.void
Methods inherited from class com.sun.codemodel.JCommentPart
add, format
Methods inherited from class java.util.ArrayList
add, addAll, addAll, addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize
Methods inherited from class java.util.AbstractCollection
containsAll, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Collection
parallelStream, stream, toArray
Methods inherited from interface java.util.List
containsAll, reversed
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
atParams
list of @param tags -
atXdoclets
list of xdoclets -
atThrows
list of @throws tags -
atReturn
The @return tag part. -
atDeprecated
The @deprecated tag -
owner
-
INDENT
- See Also:
-
-
Constructor Details
-
JDocComment
-
-
Method Details
-
append
Description copied from class:JCommentPart
Appends a new value. If the value isJType
it will be printed as a @link tag. Otherwise it will be converted to String viaObject.toString()
.- Overrides:
append
in classJCommentPart
-
addParam
Append a text to a @param tag to the javadoc -
addParam
Append a text to an @param tag. -
addThrows
add an @throws tag to the javadoc -
addThrows
add an @throws tag to the javadoc -
addReturn
Appends a text to @return tag. -
addDeprecated
add an @deprecated tag to the javadoc, with the associated message. -
addXdoclet
add an xdoclet. -
addXdoclet
add an xdoclet. -
addXdoclet
add an xdoclet. -
generate
- Specified by:
generate
in interfaceJGenerable
-