com.github.javaparser.javadoc.description

Class JavadocInlineTag

java.lang.Object

com.github.javaparser.javadoc.description.JavadocInlineTag

All Implemented Interfaces:

JavadocDescriptionElement

public class JavadocInlineTag
extends java.lang.Object
implements JavadocDescriptionElement

An inline tag contained in a Javadoc description.

For example String

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	content
private java.lang.String	tagName
private JavadocInlineTag.Type	type

Constructor Summary

Constructors

Constructor and Description
JavadocInlineTag(java.lang.String tagName, JavadocInlineTag.Type type, java.lang.String content)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static JavadocDescriptionElement	fromText(java.lang.String text)
int	hashCode()
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

tagName

private java.lang.String tagName

type

private JavadocInlineTag.Type type

content

private java.lang.String content

Constructor Detail

JavadocInlineTag

public JavadocInlineTag(java.lang.String tagName,
                        JavadocInlineTag.Type type,
                        java.lang.String content)

Method Detail

fromText

public static JavadocDescriptionElement fromText(java.lang.String text)

toText

public java.lang.String toText()

Specified by:

toText in interface JavadocDescriptionElement

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