python/openapi/src/com/jetbrains/python/documentation/PythonDocumentationQuickInfoProvider.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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);
}