public class Javadoc extends Object implements Serializable
It is composed by a description and a list of block tags.
An example would be the text contained in this very Javadoc comment. At the moment of this
writing this comment does not contain any block tags (such as @see AnotherClass
)
Constructor and Description |
---|
Javadoc() |
Javadoc(JavadocDescription description) |
Modifier and Type | Method and Description |
---|---|
Javadoc |
addBlockTag(JavadocBlockTag blockTag) |
Javadoc |
addBlockTag(String tagName) |
Javadoc |
addBlockTag(String tagName,
String parameter,
String content)
For tags like "@return good things" where tagName is "return", and the rest is content.
|
boolean |
equals(Object o) |
List<JavadocBlockTag> |
getBlockTags() |
JavadocDescription |
getDescription() |
int |
hashCode() |
static Javadoc |
parse(String commentContent)
parses the Javadoc content (description + tags)
|
static JavadocDescription |
parseText(String text)
parse the description part (before tags) of a Javadoc
|
String |
toString() |
String |
toText()
Return the text content of the document.
|
public Javadoc()
public Javadoc(JavadocDescription description)
public Javadoc addBlockTag(JavadocBlockTag blockTag)
public Javadoc addBlockTag(String tagName, String parameter, String content)
public String toText()
public JavadocDescription getDescription()
public List<JavadocBlockTag> getBlockTags()
public static JavadocDescription parseText(String text)
Copyright © 2007–2019 Inria. All rights reserved.