Package spoon.javadoc.internal

Class JavadocBlockTag

java.lang.Object

spoon.javadoc.internal.JavadocBlockTag

All Implemented Interfaces:

Serializable

public class JavadocBlockTag
extends Object
implements Serializable

A block tag.

Typically they are found at the end of Javadoc comments.

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
JavadocBlockTag(String tagName, String content)
JavadocBlockTag(String tagName, String paramName, String content)
JavadocBlockTag(CtJavaDocTag.TagType type, String content)
JavadocBlockTag(CtJavaDocTag.TagType type, String tagRealName, String content)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
JavadocDescription	getContent()
String	getName()
String	getTagName()
String	getTagRealName()
CtJavaDocTag.TagType	getType()
int	hashCode()
void	setTagRealName(String tagRealName)
String	toString()
String	toText()	pretty-prints the Javadoc tag

Methods inherited from class java.lang.Object

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

Constructor Details

JavadocBlockTag

public JavadocBlockTag(CtJavaDocTag.TagType type,
 String content)

JavadocBlockTag

public JavadocBlockTag(CtJavaDocTag.TagType type,
 String tagRealName,
 String content)

JavadocBlockTag

public JavadocBlockTag(String tagName,
 String content)

JavadocBlockTag

public JavadocBlockTag(String tagName,
 String paramName,
 String content)

Method Details

getType

public CtJavaDocTag.TagType getType()

getContent

public JavadocDescription getContent()

getName

public String getName()

getTagName

public String getTagName()

getTagRealName

public String getTagRealName()

setTagRealName

public void setTagRealName(String tagRealName)

toText

public String toText()

pretty-prints the Javadoc tag

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