Package com.github.javaparser.javadoc.description

Class JavadocDescription

java.lang.Object

com.github.javaparser.javadoc.description.JavadocDescription

public class JavadocDescription
extends java.lang.Object

A javadoc text, potentially containing inline tags. For example This class is totally unrelated to Range

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<JavadocDescriptionElement>	elements

Constructor Summary

Constructors

Constructor	Description
JavadocDescription()
JavadocDescription(java.util.List<JavadocDescriptionElement> elements)

Method Summary

Modifier and Type	Method	Description
boolean	addElement(JavadocDescriptionElement element)
boolean	equals(java.lang.Object o)
java.util.List<JavadocDescriptionElement>	getElements()
int	hashCode()
private static Pair<java.lang.Integer,java.lang.Integer>	indexOfNextInlineTag(java.lang.String text, int start)
boolean	isEmpty()
static JavadocDescription	parseText(java.lang.String text)
java.lang.String	toString()
java.lang.String	toText()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

elements

private java.util.List<JavadocDescriptionElement> elements

Constructor Detail

JavadocDescription

public JavadocDescription()

JavadocDescription

public JavadocDescription(java.util.List<JavadocDescriptionElement> elements)

Method Detail

parseText

public static JavadocDescription parseText(java.lang.String text)

indexOfNextInlineTag

private static Pair<java.lang.Integer,java.lang.Integer> indexOfNextInlineTag(java.lang.String text,
                                                                                    int start)

addElement

public boolean addElement(JavadocDescriptionElement element)

getElements

public java.util.List<JavadocDescriptionElement> getElements()

toText

public java.lang.String toText()

isEmpty

public boolean isEmpty()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object