Package com.intellij.codeInsight.navigation

Class DocPreviewUtil

java.lang.Object

com.intellij.codeInsight.navigation.DocPreviewUtil

public class DocPreviewUtil
extends java.lang.Object

Provides utility methods for building documentation preview.

Thread-safe.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	buildPreview(java.lang.String header, java.lang.String qName, java.lang.String fullText) Allows to build a documentation preview from the given arguments.

Methods inherited from class java.lang.Object

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

Method Detail

buildPreview

public static java.lang.String buildPreview(java.lang.String header,
                                            java.lang.String qName,
                                            java.lang.String fullText)

Allows to build a documentation preview from the given arguments. Basically, takes given 'header' text and tries to modify it by using hyperlink information encapsulated at the given 'full text'.

Parameters:

header - target documentation header. Is expected to be a result of the DocumentationProvider.getQuickNavigateInfo(PsiElement, PsiElement) call

qName - there is a possible case that not all documentation text will be included to the preview (according to the given 'desired rows and columns per-row' arguments). A link that points to the element with the given qualified name is added to the preview's end if the qName is provided then

fullText - full documentation text (if available)