jmlparser-core/com.github.javaparser.javadoc/Javadoc

Javadoc

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)

Constructors

Javadoc

constructor(description: JavadocDescription)

constructor(description: JavadocDescription, isMarkdownComment: Boolean)

Properties

blockTags

open val blockTags: List<JavadocBlockTag>

description

open val description: JavadocDescription

Functions

addBlockTag

open fun addBlockTag(blockTag: JavadocBlockTag): Javadoc

open fun addBlockTag(tagName: String): Javadoc

open fun addBlockTag(tagName: String, content: String): Javadoc

For tags like "@return good things" where tagName is "return", and the rest is content.

open fun addBlockTag(tagName: String, parameter: String, content: String): Javadoc

For tags like "@param abc this is a parameter" where tagName is "param", parameter is "abc" and the rest is content.

equals

open fun equals(o: Any): Boolean

hashCode

open fun hashCode(): Int

toComment

open fun toComment(): JavadocComment

Create a JavadocComment, by formatting the text of the Javadoc using no indentation (expecting the pretty printer to do the formatting.

open fun toComment(indentation: String): JavadocComment

Create a JavadocComment, by formatting the text of the Javadoc using the given indentation.

toString

open fun toString(): String

toText

open fun toText(): String

Return the text content of the document.