Package com.intellij.lang

Interface CodeDocumentationAwareCommenter

All Superinterfaces:

Commenter

All Known Subinterfaces:

CodeDocumentationAwareCommenterEx

All Known Implementing Classes:

GroovyCommenter, JavaCommenter, PropertiesCommenter, PythonCommenter, ShCommenter

public interface CodeDocumentationAwareCommenter
extends Commenter

Defines support for "Enter within comments" actions in a custom language.

See Also:

LanguageCommenters

Method Summary

Modifier and Type	Method and Description
IElementType	getBlockCommentTokenType() Returns the type of the block comment in the language, or null if the language does not support block comments.
java.lang.String	getDocumentationCommentLinePrefix() Returns the string which prefixes documentation line comment in the language, or null if the language does not support documentation comments.
java.lang.String	getDocumentationCommentPrefix() Returns the string which starts documentation comment in the language, or null if the language does not support documentation comments.
java.lang.String	getDocumentationCommentSuffix() Returns the string which ends documentation comment in the language, or null if the language does not support documentation comments.
IElementType	getDocumentationCommentTokenType() Returns the type of the documentation comment token in the language, or null if the language does not support documentation comments.
IElementType	getLineCommentTokenType() Returns the type of the line comment in the language, or null if the language does not support line comments.
boolean	isDocumentationComment(PsiComment element)

Methods inherited from interface com.intellij.lang.Commenter

getBlockCommentPrefix, getBlockCommentSuffix, getCommentedBlockCommentPrefix, getCommentedBlockCommentSuffix, getLineCommentPrefix, getLineCommentPrefixes

Method Detail

getLineCommentTokenType

IElementType getLineCommentTokenType()

Returns the type of the line comment in the language, or null if the language does not support line comments. It is assumed that line comment prefix is not null when line comment type is not null.

Returns:

the line comment type.

getBlockCommentTokenType

IElementType getBlockCommentTokenType()

Returns the type of the block comment in the language, or null if the language does not support block comments. It is assumed that block comment prefix is not null when block comment type is not null.

Returns:

the block comment type.

getDocumentationCommentTokenType

IElementType getDocumentationCommentTokenType()

Returns the type of the documentation comment token in the language, or null if the language does not support documentation comments. It is assumed that documentation comment prefix is not null when documentation comment type is not null.

Returns:

the documentation comment type.

getDocumentationCommentPrefix

java.lang.String getDocumentationCommentPrefix()

Returns the string which starts documentation comment in the language, or null if the language does not support documentation comments.

Returns:

the documentation comment text, or null.

getDocumentationCommentLinePrefix

java.lang.String getDocumentationCommentLinePrefix()

Returns the string which prefixes documentation line comment in the language, or null if the language does not support documentation comments.

Returns:

the line comment text, or null.

getDocumentationCommentSuffix

java.lang.String getDocumentationCommentSuffix()

Returns the string which ends documentation comment in the language, or null if the language does not support documentation comments.

Returns:

the documentation comment end text, or null.

isDocumentationComment

boolean isDocumentationComment(PsiComment element)