IDEA-189985: Rewrite UnsafeVfsRecursionInspection to UAST
[idea/community.git] / python / openapi / src / com / jetbrains / python / documentation / PythonDocumentationLinkProvider.java
1 // Copyright 2000-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
2 package com.jetbrains.python.documentation;
3
4 import com.intellij.openapi.extensions.ExtensionPointName;
5 import com.intellij.psi.PsiElement;
6 import com.intellij.psi.PsiNamedElement;
7 import org.jetbrains.annotations.Nls;
8 import org.jetbrains.annotations.NotNull;
9 import org.jetbrains.annotations.Nullable;
10 import org.jsoup.nodes.Document;
11
12 import java.util.function.Function;
13
14
15 public interface PythonDocumentationLinkProvider {
16   ExtensionPointName<PythonDocumentationLinkProvider> EP_NAME = ExtensionPointName.create("Pythonid.documentationLinkProvider");
17
18   @Nullable
19   String getExternalDocumentationUrl(PsiElement element, PsiElement originalElement);
20
21   @Nullable
22   default Function<Document, @Nls String> quickDocExtractor(@NotNull PsiNamedElement namedElement) {
23     return null;
24   }
25 }