public interface CtJavaDoc extends CtComment
/** * Description * @tag a tag in the javadoc */
CtComment.CommentType
LINE_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.
|
List<JavadocDescriptionElement> |
getJavadocElements()
Returns the list of parsed Javadoc elements
|
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
|
asJavaDoc, getCommentType, getContent, getRawContent, setCommentType, setContent
getLabel, insertAfter, insertAfter, insertBefore, insertBefore, setLabel
partiallyEvaluate
addAnnotation, addComment, asIterable, delete, descendantIterator, getAllMetadata, getAnnotatedChildren, getAnnotation, getAnnotation, getAnnotations, getComments, getDirectChildren, getDocComment, getElements, getMetadata, getMetadataKeys, getParent, getParent, getParent, getPath, getPosition, getReferencedTypes, getRoleInParent, getShortRepresentation, getValueByRole, hasAnnotation, hasParent, isImplicit, isParentInitialized, prettyprint, putMetadata, removeAnnotation, removeComment, replace, replace, setAllMetadata, setAnnotations, setComments, setDocComment, setImplicit, setParent, setPosition, setPositions, setValueByRole, toString, toStringDebug, updateAllParentsBelow
getFactory, setFactory
accept
filterChildren, map, map
getOriginalSourceFragment
List<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()
CtElement
Refactoring.copyType(CtType)
and Refactoring.copyMethod(CtMethod)
instead which does additional work beyond cloning.clone
in interface CtCodeElement
clone
in interface CtComment
clone
in interface CtElement
clone
in interface CtStatement
List<JavadocDescriptionElement> getJavadocElements()
Copyright © 2007–2019 Inria. All rights reserved.