Package com.intellij.codeInspection.actions

Class InspectionDescriptionDocumentationProvider

java.lang.Object

com.intellij.lang.documentation.DocumentationProviderEx

com.intellij.lang.documentation.AbstractDocumentationProvider

com.intellij.codeInspection.actions.InspectionDescriptionDocumentationProvider

All Implemented Interfaces:

DocumentationProvider

public class InspectionDescriptionDocumentationProvider
extends AbstractDocumentationProvider

Field Summary

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

EP_NAME

Constructor Summary

Constructors

Constructor and Description
InspectionDescriptionDocumentationProvider()

Method Summary

Modifier and Type	Method and Description
java.lang.String	generateDoc(PsiElement element, PsiElement originalElement) Callback for asking the doc provider for the complete documentation.

Methods inherited from class com.intellij.lang.documentation.DocumentationProviderEx

getCustomDocumentationElement, getLocalImageForElement

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

InspectionDescriptionDocumentationProvider

public InspectionDescriptionDocumentationProvider()

Method Detail

generateDoc

public java.lang.String generateDoc(PsiElement element,
                                    PsiElement originalElement)

Description copied from interface: DocumentationProvider

Callback for asking the doc provider for the complete documentation. Underlying implementation may be time-consuming, that's why this method is expected not to be called from EDT.

One can use DocumentationMarkup to get proper content layout. Typical sample will look like this:

 DEFINITION_START + definition + DEFINITION_END +
 CONTENT_START + main description + CONTENT_END +
 SECTIONS_START +
   SECTION_HEADER_START + section name +
     SECTION_SEPARATOR + "<p>" + section content + SECTION_END +
   ... +
 SECTIONS_END
 

To show different content on mouse hover in editor, DocumentationProvider.generateHoverDoc(PsiElement, PsiElement) should be implemented.

Parameters:

element - the element for which the documentation is requested (for example, if the mouse is over a method reference, this will be the method to which the reference is resolved).

originalElement - the element under the mouse cursor

Returns:

target element's documentation, or null if provider is unable to generate documentation for the given element