4e802980f2
* [webhelp] Fixes for TXP00152, TXP00002, test build 27 Jul 22:26 * [webhelp] Fixes for Part #4 TXP00010, EXCEPT decimal numbers in section titles * [webhelp] Fixes for Part #5 TXP00017 * [webhelp] Fixes for Part #4 TXP00010 - removed numbers from page section titles in "Custom Language Support Tutorial" and "Testing a Custom Language Plugin". * [webhelp] Removed numbers from page section titles in rest of project *.md files. * [new webhelp] Build #44 changes * [new webhelp] Maintenance merge from master * [new webhelp] Add placeholder file for webhelp import. * [webhelp] Correct redirects for file name changes * [webhelp] TOC not needed in webhelp * [format] {:toc} not needed for webhelp * add {:disable-links} to ensure demo links are not interpreted as real links. * Put all badges on the same line to simplify composition. * formatter.md: fix upsource link * fix some links * api_changes_list.md: remove note * migrate to webhelp - initial * fix GH edit URL * remove sdkdocs-template setup in VCS config * remove recently_updated.md * restore COC/CONTRIBUTING.md * api_changes_list.md: remove note * useful_links.md: IPE Co-authored-by: JohnHake <john.hake@jetbrains.com> Co-authored-by: Yann Cébron <yann.cebron@jetbrains.com>
1.5 KiB
To provide different kinds of documentation support, the plugin needs to provide an implementation of the DocumentationProvider interface and register it in the com.intellij.lang.documentationProvider extension point.
A standard base class for such implementations is available in AbstractDocumentationProvider.
The getQuickNavigateInfo() method returns the text to be displayed when the user holds the mouse over an element with Ctrl pressed.
When generating complete documentation via generateDoc(), use DocumentationMarkup to layout contents (see JavaDoc for details).
Additional custom actions can be added to documentation inlays and documentation popup via com.intellij.codeInsight.documentation.DocumentationActionProvider registered in com.intellij.documentationActionProvider extension point. (2020.3)
Example:
DocumentationProvider for Properties language plugin