| /* |
| * Copyright 2000-2010 JetBrains s.r.o. |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| /* |
| * User: anna |
| * Date: 02-Mar-2010 |
| */ |
| package com.intellij.lang.documentation; |
| |
| import com.intellij.openapi.project.Project; |
| import com.intellij.psi.PsiElement; |
| import org.jetbrains.annotations.Nullable; |
| |
| import java.util.List; |
| |
| public interface ExternalDocumentationProvider { |
| @Nullable |
| String fetchExternalDocumentation(final Project project, PsiElement element, final List<String> docUrls); |
| |
| /** |
| * 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 {@link DocumentationProvider#getUrlFor(com.intellij.psi.PsiElement, com.intellij.psi.PsiElement)}. |
| * |
| * @param element the element to check for existence of documentation |
| * @param originalElement the element at caret (on which the action was invoked) |
| * @return true if the external documentation action should be enabled, false otherwise. |
| */ |
| boolean hasDocumentationFor(PsiElement element, PsiElement originalElement); |
| |
| /** |
| * Checks if the provider is capable of asking the user to configure external documentation for an element. |
| * |
| * @param element the element for which no documentation was found |
| * @return true if the element is applicable to this provider and the provider has a UI to configure the documentation location, false otherwise |
| */ |
| boolean canPromptToConfigureDocumentation(PsiElement element); |
| |
| /** |
| * Prompts the user to configure the external documentation for an element if none was found. |
| * |
| * @param element the element for which no documentation was found |
| */ |
| void promptToConfigureDocumentation(PsiElement element); |
| } |