Package com.github.javaparser.javadoc
Class Javadoc
- java.lang.Object
-
- com.github.javaparser.javadoc.Javadoc
-
public class Javadoc extends Object
The structured content of a single Javadoc comment.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 Summary
Constructors Constructor Description Javadoc(JavadocDescription description)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.
-
-
-
Constructor Detail
-
Javadoc
public Javadoc(JavadocDescription description)
-
-
Method Detail
-
addBlockTag
public Javadoc addBlockTag(JavadocBlockTag blockTag)
-
addBlockTag
public Javadoc addBlockTag(String tagName, String content)
For tags like "@return good things" where tagName is "return", and the rest is content.
-
addBlockTag
public 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.
-
toText
public String toText()
Return the text content of the document. It does not containing trailing spaces and asterisks at the start of the line.
-
toComment
public JavadocComment toComment()
Create a JavadocComment, by formatting the text of the Javadoc using no indentation (expecting the pretty printer to do the formatting.)
-
toComment
public JavadocComment toComment(String indentation)
Create a JavadocComment, by formatting the text of the Javadoc using the given indentation.
-
getDescription
public JavadocDescription getDescription()
-
getBlockTags
public List<JavadocBlockTag> getBlockTags()
- Returns:
- the current List of associated JavadocBlockTags
-
-