Package com.intellij.psi.javadoc

Interface PsiDocComment

All Superinterfaces:

Iconable, PsiComment, PsiDocCommentBase, PsiElement, UserDataHolder

All Known Subinterfaces:

GrDocComment

All Known Implementing Classes:

GrDocCommentImpl, PsiDocCommentImpl

public interface PsiDocComment
extends PsiDocCommentBase

Represents a 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.PsiElement

ARRAY_FACTORY, EMPTY_ARRAY

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
PsiDocTag	findTagByName(java.lang.String name) Finds the first JavaDoc tag with the specified name.
PsiDocTag []	findTagsByName(java.lang.String name) Finds all JavaDoc tags with the specified name.
PsiElement []	getDescriptionElements() Returns the PSI elements containing the description of the element being documented (all significant tokens up to the first doc comment tag).
PsiJavaDocumentedElement	getOwner() Returns the class, method or field described by the comment.
PsiDocTag []	getTags() Returns the list of JavaDoc tags in the comment.

Methods inherited from interface com.intellij.psi.PsiComment

getTokenType

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

Method Detail

getOwner

PsiJavaDocumentedElement getOwner()

Returns the class, method or field described by the comment.

Specified by:

getOwner in interface PsiDocCommentBase

Returns:

The element which this doc comment refers to or null if there is no such element.

getDescriptionElements

PsiElement [] getDescriptionElements()

Returns the PSI elements containing the description of the element being documented (all significant tokens up to the first doc comment tag).

getTags

PsiDocTag [] getTags()

Returns the list of JavaDoc tags in the comment.

findTagByName

PsiDocTag findTagByName(java.lang.String name)

Finds the first JavaDoc tag with the specified name.

Parameters:

name - The name of the tags to find (not including the leading @ character).

Returns:

the tag with the specified name, or null if not found.

findTagsByName

PsiDocTag [] findTagsByName(java.lang.String name)

Finds all JavaDoc tags with the specified name.

Parameters:

name - The name of the tags to find (not including the leading @ character).