public class JavaCommenter extends java.lang.Object implements CodeDocumentationAwareCommenterEx
Constructor and Description |
---|
JavaCommenter() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBlockCommentPrefix()
Returns the string which marks the beginning of a block comment in the language,
or null if the language does not support block comments.
|
java.lang.String |
getBlockCommentSuffix()
Returns the string which marks the end of a block comment in the language,
or null if the language does not support block comments.
|
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 |
getCommentedBlockCommentPrefix()
Returns the string which marks the commented beginning of a block comment in the language,
or null if the language does not support block comments.
|
java.lang.String |
getCommentedBlockCommentSuffix()
Returns the string which marks the commented end of a 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.
|
java.lang.String |
getLineCommentPrefix()
Returns the string that prefixes a line comment in the language, or null if the language
does not support line 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) |
boolean |
isDocumentationCommentText(PsiElement element)
Documentation comments may consist of various nested elements: e.g.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getLineCommentPrefixes
public java.lang.String getLineCommentPrefix()
Commenter
Commenter.getLineCommentPrefixes()
to get all supported line comment prefixes.getLineCommentPrefix
in interface Commenter
public java.lang.String getBlockCommentPrefix()
Commenter
getBlockCommentPrefix
in interface Commenter
public java.lang.String getBlockCommentSuffix()
Commenter
getBlockCommentSuffix
in interface Commenter
public java.lang.String getCommentedBlockCommentPrefix()
Commenter
getCommentedBlockCommentPrefix
in interface Commenter
public java.lang.String getCommentedBlockCommentSuffix()
Commenter
getCommentedBlockCommentSuffix
in interface Commenter
public IElementType getLineCommentTokenType()
CodeDocumentationAwareCommenter
getLineCommentTokenType
in interface CodeDocumentationAwareCommenter
public IElementType getBlockCommentTokenType()
CodeDocumentationAwareCommenter
getBlockCommentTokenType
in interface CodeDocumentationAwareCommenter
public IElementType getDocumentationCommentTokenType()
CodeDocumentationAwareCommenter
getDocumentationCommentTokenType
in interface CodeDocumentationAwareCommenter
public java.lang.String getDocumentationCommentPrefix()
CodeDocumentationAwareCommenter
getDocumentationCommentPrefix
in interface CodeDocumentationAwareCommenter
public java.lang.String getDocumentationCommentLinePrefix()
CodeDocumentationAwareCommenter
getDocumentationCommentLinePrefix
in interface CodeDocumentationAwareCommenter
public java.lang.String getDocumentationCommentSuffix()
CodeDocumentationAwareCommenter
getDocumentationCommentSuffix
in interface CodeDocumentationAwareCommenter
public boolean isDocumentationComment(PsiComment element)
isDocumentationComment
in interface CodeDocumentationAwareCommenter
public boolean isDocumentationCommentText(PsiElement element)
CodeDocumentationAwareCommenterEx
isDocumentationCommentText
in interface CodeDocumentationAwareCommenterEx
element
- element to check