Package com.intellij.psi.javadoc

Interface PsiDocTag

All Superinterfaces:

Iconable, PsiElement, PsiNamedElement, UserDataHolder

All Known Subinterfaces:

GrDocInlinedTag, GrDocTag, PsiInlineDocTag

All Known Implementing Classes:

GrDocInlinedTagImpl, GrDocTagImpl, PsiDocTagImpl, PsiInlineDocTagImpl

public interface PsiDocTag
extends PsiElement, PsiNamedElement

Represents a JavaDoc tag (either an inline tag or a block tag).

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields

Modifier and Type	Field and Description
static PsiDocTag[]	EMPTY_ARRAY

Fields inherited from interface com.intellij.psi.PsiElement

ARRAY_FACTORY

Fields inherited from interface com.intellij.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Method Summary

Modifier and Type	Method and Description
PsiDocComment	getContainingComment() Returns the doc comment in which the tag is contained.
PsiElement []	getDataElements() Returns the list of all elements representing the contents of a tag.
java.lang.String	getName() Returns the name of this JavaDoc tag.
PsiElement	getNameElement() Returns the token representing the name of this JavaDoc tag.
PsiDocTagValue	getValueElement() Returns the element specifying what exactly is being documented by this tag (for example, the parameter name for a param tag or the exception name for a throws tag).

Methods inherited from interface com.intellij.psi.PsiNamedElement

setName

Methods inherited from interface com.intellij.psi.PsiElement

accept, acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContainingFile, getContext, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOwnReferences, getParent, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, processDeclarations, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArray, toString

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Methods inherited from interface com.intellij.openapi.util.Iconable

getIcon

Field Detail

EMPTY_ARRAY

static final PsiDocTag[] EMPTY_ARRAY

Method Detail

getContainingComment

PsiDocComment getContainingComment()

Returns the doc comment in which the tag is contained.

getNameElement

PsiElement getNameElement()

Returns the token representing the name of this JavaDoc tag.

getName

java.lang.String getName()

Returns the name of this JavaDoc tag.

Specified by:

getName in interface PsiNamedElement

Returns:

the element name.

getDataElements

PsiElement [] getDataElements()

Returns the list of all elements representing the contents of a tag.

getValueElement

PsiDocTagValue getValueElement()

Returns the element specifying what exactly is being documented by this tag (for example, the parameter name for a param tag or the exception name for a throws tag).

Returns:

the element, or null if the tag structure does not include such an element.