MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

mention in javadoc that DocumentationProvider.getQuickNavigateInfo return value is treated as HTML text

Browse Source
This commit is contained in:
Dmitry Batrak
2018-12-07 14:30:57 +03:00
parent 8734a97e9f
commit 682747cb69
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/lang-api/src/com/intellij/lang/documentation/DocumentationProvider.java
+2 -1
View File
@@ -45,7 +45,8 @@ public interface DocumentationProvider {
* @param element the element for which the documentation is requested (for example, if the mouse is over
* a method reference, this will be the method to which the reference is resolved).
* @param originalElement the element under the mouse cursor
* @return the documentation to show, or null if the provider can't provide any documentation for this element.
* @return the documentation to show, or null if the provider can't provide any documentation for this element. Documentation can contain
* HTML markup. If HTML special characters need to be shown in popup, they should be properly escaped.
*/
@Nullable
String getQuickNavigateInfo(PsiElement element, PsiElement originalElement);