Package com.intellij.psi

Interface PsiDocCommentOwner

All Superinterfaces:

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

All Known Subinterfaces:

GrAccessorMethod, GrAnnotationMethod, GrAnnotationTypeDefinition, GrAnonymousClassDefinition, GrClassDefinition, GrDocCommentOwner, GrEnumConstant, GrEnumConstantInitializer, GrEnumTypeDefinition, GrField, GrGdkMethod, GrInterfaceDefinition, GrMethod, GrReflectedMethod, GrTraitTypeDefinition, GrTypeDefinition, GrTypeParameter, JspClass, JspHolderMethod, PsiAnnotationMethod, PsiAnonymousClass, PsiClass, PsiEnumConstant, PsiEnumConstantInitializer, PsiExtensibleClass, PsiField, PsiJShellHolderMethod, PsiJShellRootClass, PsiMethod, PsiSyntheticClass, PsiTypeParameter

All Known Implementing Classes:

AbstractLightClass, BuilderHelperLightPsiClass, ClsClassImpl, ClsEnumConstantImpl, ClsFieldImpl, ClsMemberImpl, ClsMethodImpl, ClsTypeParameterImpl, DelegatedMethod, GrAccessorMethodImpl, GrAnnotationMethodImpl, GrAnnotationTypeDefinitionImpl, GrAnonymousClassDefinitionImpl, GrClassDefinitionImpl, GrConstructorImpl, GrDynamicImplicitMethod, GrDynamicImplicitProperty, GrDynamicMethodImpl, GrDynamicPropertyImpl, GrEnumConstantImpl, GrEnumConstantInitializerImpl, GrEnumTypeDefinitionImpl, GrFieldImpl, GrGdkMethodImpl, GrInterfaceDefinitionImpl, GrLightField, GrLightMethodBuilder, GrLightTypeDefinitionBase, GrMethodBaseImpl, GrMethodImpl, GrMethodWrapper, GroovyScriptClass, GrPropertyForCompletion, GrReflectedMethodImpl, GrRenamableLightMethodBuilder, GrScriptField, GrTraitField, GrTraitMethod, GrTraitTypeDefinitionImpl, GrTypeDefinitionImpl, GrTypeParameterImpl, InferenceVariable, LightClass, LightField, LightFieldBuilder, LightMethod, LightMethodBuilder, LightPsiClassBase, LightPsiClassBuilder, LightRecordCanonicalConstructor, LightRecordField, LightRecordMethod, LightTypeParameter, LightTypeParameterBuilder, MigrationClassImpl, PsiAnnotationMethodImpl, PsiAnonymousClassImpl, PsiClassImpl, PsiEnumConstantImpl, PsiEnumConstantInitializerImpl, PsiFieldImpl, PsiJShellHolderMethodImpl, PsiJShellRootClassImpl, PsiMethodImpl, PsiTypeParameterImpl

public interface PsiDocCommentOwner
extends PsiMember, PsiJavaDocumentedElement

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

Nested Class Summary

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

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields inherited from interface com.intellij.psi.PsiMember

EMPTY_ARRAY

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_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

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Method Summary

Modifier and Type	Method and Description
boolean	isDeprecated() Returns true if the element is marked as deprecated via an annotation or a JavaDoc tag.

Methods inherited from interface com.intellij.psi.PsiMember

getContainingClass

Methods inherited from interface com.intellij.psi.PsiModifierListOwner

getAnnotation, getAnnotations, getModifierList, hasAnnotation, hasModifier, 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, 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

Methods inherited from interface com.intellij.navigation.NavigationItem

getName, getPresentation

Methods inherited from interface com.intellij.pom.Navigatable

canNavigate, canNavigateToSource, navigate

Methods inherited from interface com.intellij.psi.PsiJavaDocumentedElement

getDocComment

Method Detail

isDeprecated

boolean isDeprecated()

Returns true if the element is marked as deprecated via an annotation or a JavaDoc tag.