public interface CtJavaDoc extends CtComment
/** * Description * @tag a tag in the javadoc */
CtComment.CommentTypeLINE_SEPARATOR| Modifier and Type | Method and Description |
|---|---|
<E extends CtJavaDoc> |
addTag(CtJavaDocTag tag)
Add a new tag at the end of the list
|
<E extends CtJavaDoc> |
addTag(int index,
CtJavaDocTag tag)
Add a new tag at the index position
|
CtJavaDoc |
clone()
Clone the element which calls this method in a new object.
|
String |
getLongDescription()
Get the long description of the javadoc
|
String |
getShortDescription()
Get the short summary of the javadoc (first sentence of the javadoc)
|
List<CtJavaDocTag> |
getTags()
Get all the tag of the javadoc
|
<E extends CtJavaDoc> |
removeTag(CtJavaDocTag tag)
Remove a specific tag
|
<E extends CtJavaDoc> |
removeTag(int index)
Remove a tag from the index
|
<E extends CtJavaDoc> |
setTags(List<CtJavaDocTag> tags)
Define the list of tags
|
getCommentType, getContent, setCommentType, setContentgetLabel, insertAfter, insertAfter, insertBefore, insertBefore, replace, setLabelpartiallyEvaluateaddAnnotation, addComment, delete, getAnnotatedChildren, getAnnotation, getAnnotation, getAnnotations, getComments, getDocComment, getElements, getMetadata, getMetadataKeys, getParent, getParent, getParent, getPosition, getReferencedTypes, getShortRepresentation, hasParent, isImplicit, isParentInitialized, putMetadata, removeAnnotation, removeComment, replace, replace, setAnnotations, setComments, setDocComment, setImplicit, setParent, setPosition, setPositions, updateAllParentsBelowgetFactory, setFactoryacceptfilterChildren, map, mapList<CtJavaDocTag> getTags()
<E extends CtJavaDoc> E setTags(List<CtJavaDocTag> tags)
tags - the new list of tags<E extends CtJavaDoc> E addTag(CtJavaDocTag tag)
tag - the new tag<E extends CtJavaDoc> E addTag(int index, CtJavaDocTag tag)
index - the index of the new tagtag - the new tag<E extends CtJavaDoc> E removeTag(int index)
index - the position of the tag to remove<E extends CtJavaDoc> E removeTag(CtJavaDocTag tag)
tag - the tag to removeString getShortDescription()
String getLongDescription()
CtJavaDoc clone()
CtElementclone in interface CtCodeElementclone in interface CtCommentclone in interface CtElementclone in interface CtStatementCopyright © 2007–2017 Inria. All rights reserved.