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 4f621089c881..7e1dbbbbb038 100644 --- a/platform/lang-api/src/com/intellij/lang/documentation/DocumentationProvider.java +++ b/platform/lang-api/src/com/intellij/lang/documentation/DocumentationProvider.java @@ -12,9 +12,12 @@ import org.jetbrains.annotations.Nullable; import java.util.List; /** + * Provides documentation for PSI elements. + *
+ * 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 diff --git a/platform/lang-api/src/com/intellij/lang/documentation/DocumentationProviderEx.java b/platform/lang-api/src/com/intellij/lang/documentation/DocumentationProviderEx.java index 99b46f54339e..614803a4b602 100644 --- a/platform/lang-api/src/com/intellij/lang/documentation/DocumentationProviderEx.java +++ b/platform/lang-api/src/com/intellij/lang/documentation/DocumentationProviderEx.java @@ -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; }