oracle.jdeveloper.jot
Interface JotDocComment

All Superinterfaces:

JotComment

public interface JotDocComment

extends JotComment

The JotDocComment represents instances of javadoc comment blocks. A javadoc comment consists of a description, which can be empty, and an optional list of doc tags.

Since:

5.0

Field Summary

Fields inherited from interface oracle.jdeveloper.jot.JotComment

BLOCK, DOC, LINE, NONE

Method Summary

JotDocTag	addTag(JotDocTag marker, boolean before, java.lang.String tagName, java.lang.String tagText) Adds a new doc tag.
java.lang.String	getDescriptionText() Retrieves the description text of this javadoc comment.
JotDocTag[]	getTags() Retrieves the javadoc doc tags associated with this comment.
void	removeAllTags()
void	removeTag(JotDocTag tag)
void	setDescriptionText(java.lang.String text) Sets the description text of this javadoc comment.

Methods inherited from interface oracle.jdeveloper.jot.JotComment

getAsDocComment, getCommentText, getText, getType, setCommentText

Method Detail

getDescriptionText

public java.lang.String getDescriptionText()

Retrieves the description text of this javadoc comment. The description text consists of all the text before the first tag. Any '*' characters at the starts of lines are omitted, as is the leading whitespace.

setDescriptionText

public void setDescriptionText(java.lang.String text)

Sets the description text of this javadoc comment. Any existing text is removed. The comment text will be automatically wrapped and any needed whitespace and '*' characters will be added.

Parameters:

text - the new text.

getTags

public JotDocTag[] getTags()

Retrieves the javadoc doc tags associated with this comment.

addTag

public JotDocTag addTag(JotDocTag marker,
                        boolean before,
                        java.lang.String tagName,
                        java.lang.String tagText)

Adds a new doc tag.

Parameters:

marker - the doc tag to position relative to.

before - whether to position the new doc tag before or after the marker doc tag; or, if the marker is null, whether to position the new doc tag at the beginning or the end of the doc tag list.

tagName - the name of the new tag; the '@' character should be omitted.

tagText - the text of the new tag.

Returns:

the new doc tag as a JotDocTag.

removeTag

public void removeTag(JotDocTag tag)

removeAllTags

public void removeAllTags()