Package com.intellij.lang.documentation

Interface ExternalDocumentationProvider

All Known Implementing Classes:

CompositeDocumentationProvider, GroovyDocumentationProvider, HtmlDocumentationProvider, JavaDocumentationProvider, PythonExternalDocumentationProvider, TaskDocumentationProvider, XHtmlDocumentationProvider

public interface ExternalDocumentationProvider

Method Summary

Modifier and Type	Method and Description
boolean	canPromptToConfigureDocumentation(PsiElement element) Checks if the provider is capable of asking the user to configure external documentation for an element.
java.lang.String	fetchExternalDocumentation(Project project, PsiElement element, java.util.List<java.lang.String> docUrls)
boolean	hasDocumentationFor(PsiElement element, PsiElement originalElement) Deprecated. existing implementations fall back to checking for existing url
void	promptToConfigureDocumentation(PsiElement element) Prompts the user to configure the external documentation for an element if none was found.

Method Detail

fetchExternalDocumentation

java.lang.String fetchExternalDocumentation(Project project,
                                            PsiElement element,
                                            java.util.List<java.lang.String> docUrls)

hasDocumentationFor

@Deprecated
boolean hasDocumentationFor(PsiElement element,
                            PsiElement originalElement)

Deprecated. existing implementations fall back to checking for existing url

Quick check for existence of external documentation for specified element. Called from action update, so must be fast. If not implemented, update check is performed by calling DocumentationProvider.getUrlFor(PsiElement, PsiElement).

Parameters:

element - the element to check for existence of documentation

originalElement - the element at caret (on which the action was invoked)

Returns:

true if the external documentation action should be enabled, false otherwise.

canPromptToConfigureDocumentation

boolean canPromptToConfigureDocumentation(PsiElement element)

Checks if the provider is capable of asking the user to configure external documentation for an element.

Parameters:

element - the element for which no documentation was found

Returns:

true if the element is applicable to this provider and the provider has a UI to configure the documentation location, false otherwise

promptToConfigureDocumentation

void promptToConfigureDocumentation(PsiElement element)

Prompts the user to configure the external documentation for an element if none was found.

Parameters:

element - the element for which no documentation was found