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

DocumentationProvider: cleanup Javadoc

Browse Source 
GitOrigin-RevId: 63e169ede38e8b574f24021c7b4460fc354c4503
This commit is contained in:
Yann Cébron
2019-07-02 06:52:16 +03:00
committed by intellij-monorepo-bot
parent 17b43cbbef
commit c695870097
2 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/lang-api/src/com/intellij/lang/documentation/DocumentationProvider.java
+6 -3
View File
@@ -12,9 +12,12 @@ import org.jetbrains.annotations.Nullable;
import java.util.List;
/**
* Provides documentation for PSI elements.
* <p>
* Extend {@link AbstractDocumentationProvider}.
*
* @see com.intellij.lang.LanguageDocumentation
* @see DocumentationProviderEx
* @see AbstractDocumentationProvider
* @see ExternalDocumentationProvider
* @see ExternalDocumentationHandler
*/
@@ -31,7 +34,7 @@ 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. Documentation can contain
* @return the documentation to show, or {@code 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
@@ -95,7 +98,7 @@ public interface DocumentationProvider {
* @param psiManager the PSI manager for the project in which the documentation is requested.
* @param link the text of the link, not including the protocol.
* @param context the element from which the navigation is performed.
* @return the navigation target, or null if the link couldn't be resolved.
* @return the navigation target, or {@code null} if the link couldn't be resolved.
* @see DocumentationManagerUtil#createHyperlink(StringBuilder, String, String, boolean)
*/
@Nullable
platform/lang-api/src/com/intellij/lang/documentation/DocumentationProviderEx.java
+3 -1
View File
@@ -20,7 +20,9 @@ public class DocumentationProviderEx implements DocumentationProvider {
* For example, it could be a keyword where there's no {@link com.intellij.psi.PsiReference}, but for which users might benefit from context help.
*/
@Nullable
public PsiElement getCustomDocumentationElement(@NotNull final Editor editor, @NotNull final PsiFile file, @Nullable PsiElement contextElement) {
public PsiElement getCustomDocumentationElement(@NotNull final Editor editor,
@NotNull final PsiFile file,
@Nullable PsiElement contextElement) {
return null;
}