From 682747cb69cc88c7dd50b4b520a4823dd6c72e73 Mon Sep 17 00:00:00 2001 From: Dmitry Batrak Date: Fri, 7 Dec 2018 14:29:07 +0300 Subject: [PATCH] mention in javadoc that DocumentationProvider.getQuickNavigateInfo return value is treated as HTML text --- .../com/intellij/lang/documentation/DocumentationProvider.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/platform/lang-api/src/com/intellij/lang/documentation/DocumentationProvider.java b/platform/lang-api/src/com/intellij/lang/documentation/DocumentationProvider.java index e108ae12acab..dfa72bcab766 100644 --- a/platform/lang-api/src/com/intellij/lang/documentation/DocumentationProvider.java +++ b/platform/lang-api/src/com/intellij/lang/documentation/DocumentationProvider.java @@ -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);