Package com.intellij.openapi.paths

Class WebReferenceDocumentationProvider

java.lang.Object

com.intellij.lang.documentation.DocumentationProviderEx

com.intellij.lang.documentation.AbstractDocumentationProvider

com.intellij.openapi.paths.WebReferenceDocumentationProvider

All Implemented Interfaces:

DocumentationProvider

public class WebReferenceDocumentationProvider
extends AbstractDocumentationProvider

Field Summary

Fields inherited from interface com.intellij.lang.documentation.DocumentationProvider

EP_NAME

Constructor Summary

Constructors

Constructor and Description
WebReferenceDocumentationProvider()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getQuickNavigateInfo(PsiElement element, PsiElement originalElement) Returns the text to show in the Ctrl-hover popup for the specified element.

Methods inherited from class com.intellij.lang.documentation.DocumentationProviderEx

getCustomDocumentationElement, getLocalImageForElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.lang.documentation.DocumentationProvider

collectDocComments, generateDoc, generateHoverDoc, generateRenderedDoc, getCustomDocumentationElement, getDocumentationElementForLink, getDocumentationElementForLookupItem, getUrlFor

Constructor Detail

WebReferenceDocumentationProvider

public WebReferenceDocumentationProvider()

Method Detail

getQuickNavigateInfo

public java.lang.String getQuickNavigateInfo(PsiElement element,
                                             PsiElement originalElement)

Description copied from interface: DocumentationProvider

Returns the text to show in the Ctrl-hover popup for the specified element.

Parameters:

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).

originalElement - the element under the mouse cursor

Returns:

the documentation to show, or 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.