1. Epic GamesDeveloper
  3. IDocumentation

IDocumentation

API > API/Editor > API/Editor/Documentation

References

   
Module Documentation
Header /Engine/Source/Editor/Documentation/Public/IDocumentation.h
Include #include "IDocumentation.h"

Syntax

class IDocumentation

Functions

  Type Name Description
Public function Const TSharedRef< class SWidget >

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

  
Public function Const TSharedRef< class SToolTip >

CreateToolTip ( const TAttribute< FText >& Text,
const TSharedPtr< SWidget >& OverrideContent,
const FString& Link,
const FString& ExcerptName
)

  
Public function Const TSharedRef< class SToolTip >

CreateToolTip ( const TAttribute< FText >& Text,
const TSharedRef< SWidget >& OverrideContent,
const TSharedPtr< class SVerticalBox >& DocVerticalBox,
const FString& Link,
const FString& ExcerptName
)

  
Public function Static TSharedRef< IDocumentation >

Get ()

  
Public function Const FString

GetBaseUrl ( const FString& Id
)

  
Public function TSharedRef< class IDocumentationPage >

GetPage ( const FString& Link,
const TSharedPtr< FParserConfiguration >& Config,
const FDocumentationStyle& Style
)

  
Public function Const const TArray< FString > &  
Public function Static bool  
Public function Const bool

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

  
Public function Const bool

Open ( const FString& Link,
FDocumentationSourceInfo Source,
const FString& BaseUrlId
)

  
Public function Const bool  
Public function Const bool

OpenHome ( const FCultureRef& Culture,
FDocumentationSourceInfo Source,
const FString& BaseUrlId
)

  
Public function Const bool

OpenHome ( FDocumentationSourceInfo Source,
const FString& BaseUrlId
)

  
Public function Const bool

PageExists ( const FString& Link,
const FCultureRef& Culture
)

  
Public function Const bool

PageExists ( const FString& Link
)

  
Public function bool

RegisterBaseUrl ( const FString& Id,
const FString& Url
)

  
Public function bool

RegisterRedirect ( const FName& Owner,
const FDocumentationRedirect& Redirect
)

 Registers a documentation redirect for an owner
Public function void

UnregisterRedirects ( const FName& Owner
)

 Unregisters all redirects owned by a specific owner

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page