Package com.intellij.lang.documentation

Interface CodeDocumentationProvider

All Superinterfaces:

DocumentationProvider

All Known Implementing Classes:

GroovyDocumentationProvider, JavaDocumentationProvider

public interface CodeDocumentationProvider
extends DocumentationProvider

Defines support for JavaDoc-like documentation stub generation when invoked on "Enter within comment" actions in a custom language.

See Also:

LanguageDocumentation

Field Summary

Fields inherited from interface com.intellij.lang.documentation.DocumentationProvider

EP_NAME

Method Summary

Modifier and Type	Method and Description
PsiComment	findExistingDocComment(PsiComment contextElement) Finds primary documentation comment within given context.
java.lang.String	generateDocumentationContentStub(PsiComment contextComment) Generate documentation comment content for given context.
Pair<PsiElement,PsiComment>	parseContext(PsiElement startPoint) Examines PSI hierarchy identified by the given 'start' element trying to find element which can be documented and it's doc comment (if any).

Methods inherited from interface com.intellij.lang.documentation.DocumentationProvider

collectDocComments, generateDoc, generateHoverDoc, generateRenderedDoc, getCustomDocumentationElement, getDocumentationElementForLink, getDocumentationElementForLookupItem, getQuickNavigateInfo, getUrlFor

Method Detail

findExistingDocComment

PsiComment findExistingDocComment(PsiComment contextElement)

Finds primary documentation comment within given context.

Parameters:

contextElement - candidate psi comment

Returns:

contextElement if no other applicable

parseContext

Pair<PsiElement,PsiComment> parseContext(PsiElement startPoint)

Examines PSI hierarchy identified by the given 'start' element trying to find element which can be documented and it's doc comment (if any).

Example:

   int test() {
     return [caret] 1;
   }
 

PSI element at the caret (return element) is an entry point. This method is expected to return PSI method element and 'null' as the existing doc comment then.

Parameters:

startPoint - start traversal point

Returns:

comment anchor which is a given element or its anchor if the one is found and its doc comment (if existing). This method may return 'null' as an indication that no doc comment anchor and existing comment is available; returned pair must have non-null PSI element and nullable existing comment references then

generateDocumentationContentStub

java.lang.String generateDocumentationContentStub(PsiComment contextComment)

Generate documentation comment content for given context.

Parameters:

contextComment - context psi comment

Returns:

documentation content for given context if any