Package spoon.javadoc.internal

Class JavadocInlineTag

java.lang.Object

spoon.javadoc.internal.JavadocInlineTag

All Implemented Interfaces:

Serializable, JavadocDescriptionElement

public class JavadocInlineTag
extends Object
implements JavadocDescriptionElement, Serializable

An inline tag contained in a Javadoc description.

For example String

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static JavadocDescriptionElement	fromText(String text)	parses a Javadoc tag
String	getContent()
String	getName()
JavadocInlineTag.Type	getType()
int	hashCode()
static String	nextWord(String string)	Return the next word of the string, in other words it stops when a space is encountered.
void	setContent(String content)
String	toString()
String	toText()	pretty-prints the Javadoc fragment

Methods inherited from class java.lang.Object

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

Constructor Details

JavadocInlineTag

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

Method Details

nextWord

public static String nextWord(String string)

Return the next word of the string, in other words it stops when a space is encountered.

fromText

public static JavadocDescriptionElement fromText(String text)

parses a Javadoc tag

setContent

public void setContent(String content)

getType

public JavadocInlineTag.Type getType()

getContent

public String getContent()

getName

public String getName()

toText

public String toText()

Description copied from interface: JavadocDescriptionElement

pretty-prints the Javadoc fragment

Specified by:

toText in interface JavadocDescriptionElement

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