Package com.intellij.lang

Interface CodeDocumentationAwareCommenterEx

All Superinterfaces:

CodeDocumentationAwareCommenter, Commenter

All Known Implementing Classes:

JavaCommenter

public interface CodeDocumentationAwareCommenterEx
extends CodeDocumentationAwareCommenter

Support for extended code documentation handling.

Method Summary

Modifier and Type	Method and Description
boolean	isDocumentationCommentText(PsiElement element) Documentation comments may consist of various nested elements: e.g.

Methods inherited from interface com.intellij.lang.CodeDocumentationAwareCommenter

getBlockCommentTokenType, getDocumentationCommentLinePrefix, getDocumentationCommentPrefix, getDocumentationCommentSuffix, getDocumentationCommentTokenType, getLineCommentTokenType, isDocumentationComment

Methods inherited from interface com.intellij.lang.Commenter

getBlockCommentPrefix, getBlockCommentSuffix, getCommentedBlockCommentPrefix, getCommentedBlockCommentSuffix, getLineCommentPrefix, getLineCommentPrefixes

Method Detail

isDocumentationCommentText

boolean isDocumentationCommentText(PsiElement element)

Documentation comments may consist of various nested elements: e.g. javadoc tags, start/end markers, and comment text elements. This method verifies is given element represents the latter.

Parameters:

element - element to check

Returns:

true if the element is a documentation comment part with text