Package com.github.javaparser.javadoc

Class JavadocBlockTag

java.lang.Object

com.github.javaparser.javadoc.JavadocBlockTag

public class JavadocBlockTag
extends Object

A block tag.

Typically they are found at the end of Javadoc comments.

Examples: @see AnotherClass @since v0.0.1 @author Jim O'Java

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavadocBlockTag.Type	The type of tag: it could either correspond to a known tag (param, return, etc.) or represent an unknown tag.

Constructor Summary

Constructors

Constructor	Description
JavadocBlockTag(JavadocBlockTag.Type type, String content)
JavadocBlockTag(String tagName, String content)

Method Summary

Modifier and Type	Method	Description
static JavadocBlockTag	createParamBlockTag(String paramName, String content)
boolean	equals(Object o)
JavadocDescription	getContent()
Optional<String>	getName()
String	getTagName()
JavadocBlockTag.Type	getType()
int	hashCode()
String	toString()
String	toText()

Methods inherited from class java.lang.Object

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

Constructor Details

JavadocBlockTag

public JavadocBlockTag(JavadocBlockTag.Type type,
 String content)

JavadocBlockTag

public JavadocBlockTag(String tagName,
 String content)

Method Details

createParamBlockTag

public static JavadocBlockTag createParamBlockTag(String paramName,
 String content)

getType

public JavadocBlockTag.Type getType()

getContent

public JavadocDescription getContent()

getName

public Optional<String> getName()

getTagName

public String getTagName()

toText

public String toText()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object