IDocumentation

Choose your operating system:

Windows

macOS

Linux

References

Module

Documentation

Header

/Engine/Source/Editor/Documentation/Public/IDocumentation.h

Include

#include "IDocumentation.h"

Syntax

class IDocumentation

Functions

Name Description

Public function Const

TSharedRef< ...

 

CreateAnchor

(
    const TAttribute< FString >& Link,
    const FString& PreviewLink,
    const FString& PreviewExcerptName
)

Public function Const

TSharedRef< ...

 

CreateToolTip

(
    const TAttribute< FText >& Text,
    const TSharedPtr< SWidget >& Overr...,
    const FString& Link,
    const FString& ExcerptName
)

Public function Const

TSharedRef< ...

 

CreateToolTip

(
    const TAttribute< FText >& Text,
    const TSharedRef< SWidget >& Overr...,
    const TSharedPtr< class SVerticalBo...,
    const FString& Link,
    const FString& ExcerptName
)

Public function Static

TSharedRef< ...

 

Get()

Public function

TSharedRef< ...

 

GetPage

(
    const FString& Link,
    const TSharedPtr< FParserConfigurat...,
    const FDocumentationStyle& Style
)

Public function Static

bool

 

IsAvailable()

Public function Const

bool

 

Open

(
    const FString& Link,
    FDocumentationSourceInfo Source
)

Public function Const

bool

 

Open

(
    const FString& Link,
    const FCultureRef& Culture,
    FDocumentationSourceInfo Source
)

Public function Const

bool

 

OpenAPIHome

(
    FDocumentationSourceInfo Source
)

Public function Const

bool

 

OpenHome

(
    FDocumentationSourceInfo Source
)

Public function Const

bool

 

OpenHome

(
    const FCultureRef& Culture,
    FDocumentationSourceInfo Source
)

Public function Const

bool

 

PageExists

(
    const FString& Link
)

Public function Const

bool

 

PageExists

(
    const FString& Link,
    const FCultureRef& Culture
)