hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 18:27:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

documentation.md: minor edits

Browse Source
This commit is contained in:
Yann Cébron 2024-02-05 13:50:39 +01:00
parent 6c2236e1ea
commit f651f414c3
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
topics/reference_guide/custom_language_support/documentation.md
View File

@ -1,7 +1,7 @@
<!-- Copyright 2000-2023 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Documentation
<!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
<link-summary>Providing code documentation displayed in the popup invoked by hovering over a symbol or invoking the "View | Quick Documentation" action.</link-summary>
<tldr>
@ -26,9 +26,9 @@ Detailed information on implementing these EPs can be found in the [](#documenta
> Plugins targeting versions earlier than 2023.1 must use the [Documentation Provider API](#documentation-provider-api).
> Note that as long as the transition to the new API is
> not complete, the [custom language tutorial](documentation_provider.md) will use `DocumentationProvider`.
> not complete, the [custom language tutorial](documentation_provider.md) will continue using `DocumentationProvider`.
>
{style="note"}
{title="Targeting IDEs before 2023.1" style="note"}
## Documentation Target API
@ -85,7 +85,7 @@ before, then `computeDocumentation()` should do the work that was formerly done
In addition to showing the documentation, the `computeDocumentationHint()` method returns the text to be displayed
when the user hovers over an element with <shortcut>Ctrl</shortcut>/<shortcut>Cmd</shortcut> pressed or when
<ui-path>Preferences | Editor | Code Editing | "Show quick documentation on hover"</ui-path> is enabled.
<ui-path>Settings | Editor | Code Editing | Show quick documentation on hover</ui-path> is enabled.
In the old framework, this method was called `DocumentationProvider.getQuickNavigateInfo()`.
The `createPointer()` method manages instance restoration and ensures access to the entity across different read actions.
@ -105,10 +105,10 @@ as a reference.
## Documentation Provider API
> As of IntelliJ Platform version 2023.1 the Documentation Provider API is deprecated and plugin
> authors should use the [](#documentation-target-api).
> As of IntelliJ Platform version 2023.1, the Documentation Provider API is deprecated and plugin
> authors should use the [](#documentation-target-api) instead.
>
{style="note"}
{title="Deprecation Notice" style="note"}
Custom language developers usually extend from
[`AbstractDocumentationProvider`](%gh-ic%/platform/analysis-api/src/com/intellij/lang/documentation/AbstractDocumentationProvider.java)