2020-08-31 17:28:14 +02:00

1.3 KiB

title
Documentation

To provide different kinds of documentation support, 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.

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

When generating complete documentation via generateDoc(), use DocumentationMarkup to layout contents (see JavaDoc for details).

Example: DocumentationProvider for Properties language plugin