public class Javadoc extends Object
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(JavadocDescription description) |
Modifier and Type | Method and Description |
---|---|
Javadoc |
addBlockTag(JavadocBlockTag blockTag) |
Javadoc |
addBlockTag(String tagName) |
Javadoc |
addBlockTag(String tagName,
String content)
For tags like "@return good things" where
tagName is "return",
and the rest is content.
|
Javadoc |
addBlockTag(String tagName,
String parameter,
String content)
For tags like "@param abc this is a parameter" where
tagName is "param",
parameter is "abc"
and the rest is content.
|
boolean |
equals(Object o) |
List<JavadocBlockTag> |
getBlockTags() |
JavadocDescription |
getDescription() |
int |
hashCode() |
JavadocComment |
toComment()
Create a JavadocComment, by formatting the text of the Javadoc using no indentation (expecting the pretty printer to do the formatting.)
|
JavadocComment |
toComment(String indentation)
Create a JavadocComment, by formatting the text of the Javadoc using the given indentation.
|
String |
toString() |
String |
toText()
Return the text content of the document.
|
public Javadoc(JavadocDescription description)
public Javadoc addBlockTag(JavadocBlockTag blockTag)
public Javadoc addBlockTag(String tagName, String content)
public Javadoc addBlockTag(String tagName, String parameter, String content)
public String toText()
public JavadocComment toComment()
public JavadocComment toComment(String indentation)
public JavadocDescription getDescription()
public List<JavadocBlockTag> getBlockTags()
Copyright © 2007–2018. All rights reserved.