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
breandan 801b0b640f Migrate links to .java classes from GitHub to Upsource. 
The first step in migrating the documentation to Upsource. This has the added benefit of tying us to a specific version in case of code drift. Future migrations will be required in order to use method links (when supported).

Search:  \(https://github.com/JetBrains/intellij-community/blob/master/(.+\.java)\)
Replace: \(https://upsource.jetbrains.com/idea-community/file/1731d054af4ca27aa827c03929e27eeb0e6a8366/$1\)
2015-08-18 16:40:09 -04:00

1.2 KiB
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.