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

documentation.md: Add code formatting to titles

Browse Source
This commit is contained in:
Karol Lewandowski 2024-04-08 14:21:52 +02:00
parent 5389264037
commit 9b577648ca
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,7 +1,7 @@
# Documentation
<!-- Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
# Documentation
<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>
@ -54,19 +54,19 @@ outlining the primary components and their interactions.
</procedure>
{style="full"}
DocumentationTargetProvider
`DocumentationTargetProvider`
: Implement
[`DocumentationTargetProvider`](%gh-ic%/platform/lang-impl/src/com/intellij/platform/backend/documentation/DocumentationTargetProvider.java)
and register it as `com.intellij.platform.backend.documentation.targetProvider` extension point to build documentation
for a certain offset in a `PsiFile` by overriding `documentationTargets()`.
PsiDocumentationTargetProvider
`PsiDocumentationTargetProvider`
: Implement
[`PsiDocumentationTargetProvider`](%gh-ic%/platform/lang-impl/src/com/intellij/platform/backend/documentation/PsiDocumentationTargetProvider.java)
and register it as `com.intellij.platform.backend.documentation.psiTargetProvider` extension point to build documentation
for PSI elements by overriding `documentationTarget()`.
SymbolDocumentationTargetProvider
`SymbolDocumentationTargetProvider`
: Implement
[`SymbolDocumentationTargetProvider`](%gh-ic%/platform/lang-impl/src/com/intellij/platform/backend/documentation/SymbolDocumentationTargetProvider.java)
and register it as `com.intellij.platform.backend.documentation.symbolTargetProvider` extension point to build documentation