oracle.javatools.parser.java.v2.model.doc

Interface SourceDocHasDescription

All Superinterfaces:

Element, SourceDocElement, SourceElement

All Known Subinterfaces:

SourceDocBlockTag, SourceDocComment, SourceDocInlineTag, SourceDocTag

public interface SourceDocHasDescription
extends SourceDocElement

A doc element that has a description.

Field Summary

Fields inherited from interface oracle.javatools.parser.java.v2.model.SourceElement

CHILDREN_ALL, CHILDREN_BLANKLINES, CHILDREN_COMMENTS, CHILDREN_default, CHILDREN_none, CHILDREN_REGULAR, EMPTY_ARRAY, PRINT_ALL, REFORMAT_ALL, REFORMAT_INDENT

Method Summary

Methods

Modifier and Type	Method and Description
SourceDocDescription	getDescription() Gets the description argument of this tag, or null for a tag with no description.
void	setDescription(SourceDocDescription description) Sets the description argument of this tag.

Methods inherited from interface oracle.javatools.parser.java.v2.model.doc.SourceDocElement

getDocText, getInlineTags, getOwningDocComment, getOwningMember, getReferences, isBlank

Methods inherited from interface oracle.javatools.parser.java.v2.model.SourceElement

addSelf, addSelf, addSelfAfter, addSelfBefore, adjustTextIndentation, clearBinding, cloneSelf, compile, getBinding, getChildren, getChildren, getCompiledObject, getContainedElements, getEndOffset, getJdkVersion, getOwningFile, getOwningSourceFile, getParent, getSiblingAfter, getSiblingBefore, getSiblings, getSiblings, getStartOffset, getSymbolKind, getText, getTokens, hasErrors, print, print, reformatSelf, removeSelf, replaceSelf, resolve, setBinding, setContext, visitSelf

Method Detail

getDescription

SourceDocDescription getDescription()

Gets the description argument of this tag, or null for a tag with no description. See the class overview for a description of the elements in each tag; in all cases the description element is the last argument.

setDescription

void setDescription(SourceDocDescription description)

Sets the description argument of this tag.

Parameters:

description - The new, non-null, description.