hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 09:17:50 +08:00
Code Issues Packages Projects Releases Wiki Activity
intellij-sdk-code-samples/reference_guide/custom_language_support/documentation.md
Matt Ellis ca989bbb03 Simplified links to Upsource 
Now using upsource:// protocol and converted to full link at build time.
2015-11-26 15:39:11 +00:00

994 B
Raw Blame History

title
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 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.