IntelliJ Platform SDK DevGuide

Edit page

Documentation

To provide different kinds of documentation support (tooltips on Ctrl-hover, quick documentation popup etc.), the plugin needs to provide an implementation of the DocumentationProvider interface and register it in the com.intellij.lang.documentationProvider extension point. A standard base class for such implementations is available in the class AbstractDocumentationProvider.

Example: DocumentationProvider for Properties language plugin

The getQuickNavigateInfo() method returns the text to be displayed when the user holds the mouse over an element with Ctrl pressed.

Last modified: 19 February 2020