public class Javadoc
extends java.lang.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
)
Modifier and Type | Field and Description |
---|---|
private java.util.List<JavadocBlockTag> |
blockTags |
private JavadocDescription |
description |
Constructor and Description |
---|
Javadoc(JavadocDescription description) |
Modifier and Type | Method and Description |
---|---|
Javadoc |
addBlockTag(JavadocBlockTag blockTag) |
Javadoc |
addBlockTag(java.lang.String tagName) |
Javadoc |
addBlockTag(java.lang.String tagName,
java.lang.String content) |
boolean |
equals(java.lang.Object o) |
java.util.List<JavadocBlockTag> |
getBlockTags() |
JavadocDescription |
getDescription() |
int |
hashCode() |
JavadocComment |
toComment(java.lang.String indentation)
Create a JavadocComment, by formatting the text of the Javadoc using the given indentation/
|
java.lang.String |
toString() |
java.lang.String |
toText()
Return the text content of the document.
|
private JavadocDescription description
private java.util.List<JavadocBlockTag> blockTags
public Javadoc(JavadocDescription description)
public Javadoc addBlockTag(JavadocBlockTag blockTag)
public Javadoc addBlockTag(java.lang.String tagName, java.lang.String content)
public Javadoc addBlockTag(java.lang.String tagName)
public java.lang.String toText()
public JavadocComment toComment(java.lang.String indentation)
public JavadocDescription getDescription()
public java.util.List<JavadocBlockTag> getBlockTags()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object