diff --git a/RegExpSupport/src/org/intellij/lang/regexp/RegExpDocumentationProvider.java b/RegExpSupport/src/org/intellij/lang/regexp/RegExpDocumentationProvider.java index 40e89fc2e164..504a6752dbdd 100644 --- a/RegExpSupport/src/org/intellij/lang/regexp/RegExpDocumentationProvider.java +++ b/RegExpSupport/src/org/intellij/lang/regexp/RegExpDocumentationProvider.java @@ -16,7 +16,7 @@ package org.intellij.lang.regexp; import com.intellij.lang.ASTNode; -import com.intellij.lang.documentation.QuickDocumentationProvider; +import com.intellij.lang.documentation.AbstractDocumentationProvider; import com.intellij.psi.PsiElement; import com.intellij.psi.PsiManager; import org.intellij.lang.regexp.psi.RegExpElement; @@ -28,7 +28,7 @@ import org.jetbrains.annotations.Nullable; /** * @author vnikolaenko */ -public class RegExpDocumentationProvider extends QuickDocumentationProvider { +public class RegExpDocumentationProvider extends AbstractDocumentationProvider { @Override @Nullable public String generateDoc(PsiElement element, PsiElement originalElement) { diff --git a/images/src/org/intellij/images/fileTypes/ImageDocumentationProvider.java b/images/src/org/intellij/images/fileTypes/ImageDocumentationProvider.java index d1826fecb145..49199eb0da7e 100644 --- a/images/src/org/intellij/images/fileTypes/ImageDocumentationProvider.java +++ b/images/src/org/intellij/images/fileTypes/ImageDocumentationProvider.java @@ -15,7 +15,7 @@ */ package org.intellij.images.fileTypes; -import com.intellij.lang.documentation.QuickDocumentationProvider; +import com.intellij.lang.documentation.AbstractDocumentationProvider; import com.intellij.openapi.util.SystemInfo; import com.intellij.openapi.vfs.VirtualFile; import com.intellij.openapi.vfs.VirtualFileWithId; @@ -30,13 +30,9 @@ import java.net.URISyntaxException; /** * @author spleaner */ -public class ImageDocumentationProvider extends QuickDocumentationProvider { +public class ImageDocumentationProvider extends AbstractDocumentationProvider { private static final int MAX_IMAGE_SIZE = 300; - public String getQuickNavigateInfo(PsiElement element, PsiElement originalElement) { - return null; - } - @Override public String generateDoc(PsiElement element, PsiElement originalElement) { final String[] result = new String[] {null}; diff --git a/java/java-impl/src/com/intellij/lang/java/FileDocumentationProvider.java b/java/java-impl/src/com/intellij/lang/java/FileDocumentationProvider.java index 22165ea4b7ef..d52530598263 100644 --- a/java/java-impl/src/com/intellij/lang/java/FileDocumentationProvider.java +++ b/java/java-impl/src/com/intellij/lang/java/FileDocumentationProvider.java @@ -17,17 +17,13 @@ package com.intellij.lang.java; import com.intellij.codeInsight.javadoc.JavaDocExternalFilter; import com.intellij.codeInsight.javadoc.JavaDocInfoGenerator; -import com.intellij.lang.documentation.QuickDocumentationProvider; +import com.intellij.lang.documentation.AbstractDocumentationProvider; import com.intellij.psi.PsiElement; /** * @author spleaner */ -public class FileDocumentationProvider extends QuickDocumentationProvider { - - public String getQuickNavigateInfo(PsiElement element, PsiElement originalElement) { - return null; - } +public class FileDocumentationProvider extends AbstractDocumentationProvider { @Override public String generateDoc(PsiElement element, PsiElement originalElement) { diff --git a/platform/lang-api/src/com/intellij/lang/documentation/AbstractDocumentationProvider.java b/platform/lang-api/src/com/intellij/lang/documentation/AbstractDocumentationProvider.java new file mode 100644 index 000000000000..91c903af7d41 --- /dev/null +++ b/platform/lang-api/src/com/intellij/lang/documentation/AbstractDocumentationProvider.java @@ -0,0 +1,52 @@ +/* + * Copyright 2000-2011 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. + */ +package com.intellij.lang.documentation; + +import com.intellij.psi.PsiElement; +import com.intellij.psi.PsiManager; + +import java.util.List; + +/** + * @author Dmitry Avdeev + */ +public abstract class AbstractDocumentationProvider implements DocumentationProvider { + + @Override + public String getQuickNavigateInfo(PsiElement element, PsiElement originalElement) { + return null; + } + + @Override + public List getUrlFor(PsiElement element, PsiElement originalElement) { + return null; + } + + @Override + public String generateDoc(PsiElement element, PsiElement originalElement) { + return null; + } + + @Override + public PsiElement getDocumentationElementForLookupItem(PsiManager psiManager, Object object, PsiElement element) { + return null; + } + + @Override + public PsiElement getDocumentationElementForLink(PsiManager psiManager, String link, PsiElement context) { + return null; + } +} 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 74e1ec5b7d5e..b889b30f7aff 100644 --- a/platform/lang-api/src/com/intellij/lang/documentation/DocumentationProvider.java +++ b/platform/lang-api/src/com/intellij/lang/documentation/DocumentationProvider.java @@ -25,6 +25,7 @@ import java.util.List; /** * @see com.intellij.lang.LanguageDocumentation + * @see AbstractDocumentationProvider */ public interface DocumentationProvider { diff --git a/platform/lang-api/src/com/intellij/lang/documentation/QuickDocumentationProvider.java b/platform/lang-api/src/com/intellij/lang/documentation/QuickDocumentationProvider.java index 45927d2cc97e..29901cb03d27 100644 --- a/platform/lang-api/src/com/intellij/lang/documentation/QuickDocumentationProvider.java +++ b/platform/lang-api/src/com/intellij/lang/documentation/QuickDocumentationProvider.java @@ -22,6 +22,10 @@ import org.jetbrains.annotations.Nullable; import java.util.List; +/** + * @see AbstractDocumentationProvider + */ +@Deprecated public abstract class QuickDocumentationProvider implements DocumentationProvider { @Nullable diff --git a/plugins/properties/src/com/intellij/lang/properties/PropertiesDocumentationProvider.java b/plugins/properties/src/com/intellij/lang/properties/PropertiesDocumentationProvider.java index 75be88e8c853..c0142a2a7566 100644 --- a/plugins/properties/src/com/intellij/lang/properties/PropertiesDocumentationProvider.java +++ b/plugins/properties/src/com/intellij/lang/properties/PropertiesDocumentationProvider.java @@ -19,7 +19,7 @@ */ package com.intellij.lang.properties; -import com.intellij.lang.documentation.QuickDocumentationProvider; +import com.intellij.lang.documentation.AbstractDocumentationProvider; import com.intellij.lang.properties.psi.Property; import com.intellij.openapi.editor.colors.EditorColorsManager; import com.intellij.openapi.editor.markup.TextAttributes; @@ -32,7 +32,7 @@ import org.jetbrains.annotations.Nullable; import java.awt.*; -public class PropertiesDocumentationProvider extends QuickDocumentationProvider { +public class PropertiesDocumentationProvider extends AbstractDocumentationProvider { @Nullable public String getQuickNavigateInfo(PsiElement element, PsiElement originalElement) { if (element instanceof Property) {