oracle.jdeveloper.jot
Interface JotDocTag

public interface JotDocTag

The JotDocTag interface represents instances of tags inside of a JavaDoc comment block. A doc tag consists of two parts: a tag name and tag text. In the raw comment text, tags are preceeded with the character '@' (for example @author); this character is not included in the tag name.

Since:

5.0

Method Summary

java.lang.String	getTagName() Retrieves the name of this doc tag.
java.lang.String	getTagText() The text of this doc tag.
void	setTagName(java.lang.String tagName) Sets the name of this doc tag.
void	setTagText(java.lang.String tagText) Sets the text of this doc tag.

Method Detail

getTagName

public java.lang.String getTagName()

Retrieves the name of this doc tag.

Returns:

the name of the tag; the '@' is not included.

setTagName

public void setTagName(java.lang.String tagName)

Sets the name of this doc tag.

Parameters:

tagName - the new name of the tag; the '@' should not be included.

getTagText

public java.lang.String getTagText()

The text of this doc tag.

Returns:

the text of this tag.

setTagText

public void setTagText(java.lang.String tagText)

Sets the text of this doc tag.

Parameters:

tagText - the new text of this tag.