Package com.intellij.codeInsight.editorActions

Class CodeDocumentationUtil

java.lang.Object

com.intellij.codeInsight.editorActions.CodeDocumentationUtil

public class CodeDocumentationUtil
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodeDocumentationUtil.CommentContext Utility class that contains information about current comment context.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	createDocCommentLine(java.lang.String lineData, Project project, CodeDocumentationAwareCommenter commenter) Deprecated. Use createDocCommentLine(lineData,file,commenter) instead.
static java.lang.String	createDocCommentLine(java.lang.String lineData, PsiFile file, CodeDocumentationAwareCommenter commenter)
static java.lang.String	getIndentInsideJavadoc(Document document, int offset) Utility method that does the following:
static CodeDocumentationUtil.CommentContext	tryParseCommentContext(PsiFile file, java.lang.CharSequence chars, int offset, int lineStartOffset) Analyzes position at the given offset at the given text and returns information about comments presence and kind there if any.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createDocCommentLine

@Deprecated
public static java.lang.String createDocCommentLine(java.lang.String lineData,
                                                    Project project,
                                                    CodeDocumentationAwareCommenter commenter)

Deprecated. Use createDocCommentLine(lineData,file,commenter) instead.

createDocCommentLine

public static java.lang.String createDocCommentLine(java.lang.String lineData,
                                                    PsiFile file,
                                                    CodeDocumentationAwareCommenter commenter)

getIndentInsideJavadoc

public static java.lang.String getIndentInsideJavadoc(Document document,
                                                      int offset)

Utility method that does the following:

 

   
Checks if target document line that contains given offset starts with '*';
   
Returns document text located between the '*' and first non-white space symbols after it if the check above is successful;
 
   

Parameters:

document - target document

offset - target offset that identifies line to check and max offset to use during scanning

Returns:

tryParseCommentContext

public static CodeDocumentationUtil.CommentContext tryParseCommentContext(PsiFile file,
                                                                          java.lang.CharSequence chars,
                                                                          int offset,
                                                                          int lineStartOffset)

Analyzes position at the given offset at the given text and returns information about comments presence and kind there if any.

Parameters:

file - target file being edited (necessary for language recognition at target offset. Language is necessary to get information about specific comment syntax)

chars - target text

offset - target offset at the given text

lineStartOffset - start offset of the line that contains given offset

Returns:

object that encapsulates information about comments at the given offset at the given text