com.intellij.psi
Interface PsiDocCommentOwner

All Superinterfaces:

Iconable, Navigatable, NavigationItem, PsiElement, PsiMember, PsiModifierListOwner, UserDataHolder

All Known Subinterfaces:

PsiAnnotationMethod, PsiAnonymousClass, PsiAspect, PsiAspectField, PsiAspectMethod, PsiClass, PsiEnumConstant, PsiEnumConstantInitializer, PsiField, PsiIntertypeField, PsiIntertypeMethod, PsiMethod, PsiTypeParameter

public interface PsiDocCommentOwner
extends PsiMember

Represents a PSI element which can have an attached JavaDoc comment.

Field Summary

Fields inherited from interface com.intellij.psi.PsiMember

EMPTY_ARRAY

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

ICON_FLAG_CLOSED, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Method Summary

PsiDocComment	getDocComment() Returns the JavaDoc comment for the element.
boolean	isDeprecated() Checks if the element is marked as deprecated via an annotation or JavaDoc tag.

Methods inherited from interface com.intellij.psi.PsiMember

getContainingClass

Methods inherited from interface com.intellij.psi.PsiModifierListOwner

getModifierList, hasModifierProperty

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, getParent, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getUseScope, isPhysical, isValid, isWritable, processDeclarations, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArray

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

getUserData, putUserData

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

getIcon

Methods inherited from interface com.intellij.navigation.NavigationItem

getFileStatus, getName, getPresentation

Methods inherited from interface com.intellij.pom.Navigatable

canNavigate, canNavigateToSource, navigate

Method Detail

getDocComment

@Nullable
PsiDocComment getDocComment()

Returns the JavaDoc comment for the element.

Returns:

the JavaDoc comment instance, or null if the element has no JavaDoc comment.

isDeprecated

boolean isDeprecated()

Checks if the element is marked as deprecated via an annotation or JavaDoc tag.

Returns:

true is the element is marked as deprecated, false otherwise.