summaryrefslogtreecommitdiff
path: root/python/openapi/src/com/jetbrains/python/documentation/PythonDocumentationQuickInfoProvider.java
diff options
context:
space:
mode:
Diffstat (limited to 'python/openapi/src/com/jetbrains/python/documentation/PythonDocumentationQuickInfoProvider.java')
-rw-r--r--python/openapi/src/com/jetbrains/python/documentation/PythonDocumentationQuickInfoProvider.java25
1 files changed, 25 insertions, 0 deletions
diff --git a/python/openapi/src/com/jetbrains/python/documentation/PythonDocumentationQuickInfoProvider.java b/python/openapi/src/com/jetbrains/python/documentation/PythonDocumentationQuickInfoProvider.java
new file mode 100644
index 000000000000..52dc4732133c
--- /dev/null
+++ b/python/openapi/src/com/jetbrains/python/documentation/PythonDocumentationQuickInfoProvider.java
@@ -0,0 +1,25 @@
+package com.jetbrains.python.documentation;
+
+import com.intellij.openapi.extensions.ExtensionPointName;
+import com.intellij.psi.PsiElement;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Allows you to inject quick info into python documentation provider
+ *
+ * @author Ilya.Kazakevich
+ */
+public interface PythonDocumentationQuickInfoProvider {
+ ExtensionPointName<PythonDocumentationQuickInfoProvider> EP_NAME =
+ ExtensionPointName.create("Pythonid.pythonDocumentationQuickInfoProvider");
+
+ /**
+ * Return quick info for <strong>original</strong> element.
+ *
+ * @param originalElement original element
+ * @return info (if exists) or null (if another provider should be checked)
+ */
+ @Nullable
+ String getQuickInfo(@NotNull PsiElement originalElement);
+}