mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-28 17:27:49 +08:00
801b0b640f
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\)
18 lines
1.2 KiB
Markdown
18 lines
1.2 KiB
Markdown
---
|
|
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](https://upsource.jetbrains.com/idea-community/file/1731d054af4ca27aa827c03929e27eeb0e6a8366/platform/lang-api/src/com/intellij/lang/documentation/DocumentationProvider.java)
|
|
interface and register it in the `lang.documentationProvider` extension point.
|
|
A standard base class for such implementations is available in the class
|
|
[AbstractDocumentationProvider](https://upsource.jetbrains.com/idea-community/file/1731d054af4ca27aa827c03929e27eeb0e6a8366/platform/lang-api/src/com/intellij/lang/documentation/AbstractDocumentationProvider.java).
|
|
|
|
**Example**:
|
|
[DocumentationProvider](https://upsource.jetbrains.com/idea-community/file/1731d054af4ca27aa827c03929e27eeb0e6a8366/plugins/properties/src/com/intellij/lang/properties/PropertiesDocumentationProvider.java)
|
|
for
|
|
[Properties language plugin](https://github.com/JetBrains/intellij-community/tree/master/plugins/properties/)
|
|
|
|
|
|
The `getQuickNavigateInfo()` method returns the text to be displayed when the user holds the mouse over an element with `Ctrl` pressed.
|