public class GeneratedJavaDocComment extends CommentPart implements Generable
modCount
Constructor and Description |
---|
GeneratedJavaDocComment(CodeModel owner) |
Modifier and Type | Method and Description |
---|---|
CommentPart |
addDeprecated()
add an @deprecated tag to the javadoc, with the associated message.
|
CommentPart |
addParam(GeneratedVariable param)
Append a text to an @param tag.
|
CommentPart |
addParam(String param)
Append a text to a @param tag to the javadoc
|
CommentPart |
addReturn(String ret)
Appends a text to @return tag.
|
CommentPart |
addThrows(Class<? extends Throwable> exception)
add an @throws tag to the javadoc
|
CommentPart |
addThrows(TypeReference 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.
|
GeneratedJavaDocComment |
append(Object o)
Appends a new value.
|
void |
generate(Formatter 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
equals, hashCode
containsAll, toString
finalize, getClass, notify, notifyAll, wait, wait, wait
containsAll, equals, hashCode
public GeneratedJavaDocComment(CodeModel owner)
public GeneratedJavaDocComment append(Object o)
CommentPart
Type
it will be printed as a @link tag.
Otherwise it will be converted to String via Object.toString()
.append
in class CommentPart
public CommentPart addParam(String param)
public CommentPart addParam(GeneratedVariable param)
public CommentPart addThrows(Class<? extends Throwable> exception)
public CommentPart addThrows(TypeReference exception)
public CommentPart addReturn(String ret)
public CommentPart addDeprecated()
public Map<String,String> addXdoclet(String name, Map<String,String> attributes)
public Map<String,String> addXdoclet(String name, String attribute, String value)
Copyright © 2010–2015 MuleSoft, Inc.. All rights reserved.