Package com.intellij.codeInsight.javadoc

Class DocumentationDelegateProvider

java.lang.Object

com.intellij.codeInsight.javadoc.DocumentationDelegateProvider

Direct Known Subclasses:

GrLightDocumentationDelegateProvider

public abstract class DocumentationDelegateProvider
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<DocumentationDelegateProvider>	EP_NAME

Constructor Summary

Constructors

Constructor and Description
DocumentationDelegateProvider()

Method Summary

Modifier and Type	Method and Description
abstract PsiDocCommentOwner	computeDocumentationDelegate(PsiMember member) Computes PsiDocCommentOwner to get documentation from.
static PsiDocCommentOwner	findDocumentationDelegate(PsiMember method)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EP_NAME

public static final ExtensionPointName<DocumentationDelegateProvider> EP_NAME

Constructor Detail

DocumentationDelegateProvider

public DocumentationDelegateProvider()

Method Detail

computeDocumentationDelegate

public abstract PsiDocCommentOwner computeDocumentationDelegate(PsiMember member)

Computes PsiDocCommentOwner to get documentation from.

Suppose there is a Foo#bar() with doc and Baz#bar() without doc:

 class Foo {
   /**
   * Some javadoc
   */
   void bar() {}
 }
 class Baz {
   void bar() {}
 }
 

If it is needed to display doc from Foo#bar() when doc for Baz#bar() is queried then this method should return PsiMethod corresponding to Foo#bar() for PsiMethod corresponding to Baz#bar().
The copied documentation will include Description copied from link.

Parameters:

member - method to search delegate for.

Returns:

delegate PsiDocCommentOwner instance.

findDocumentationDelegate

public static PsiDocCommentOwner findDocumentationDelegate(PsiMember method)