UField::FormatNativeToolTip

Formats a source comment into the form we want to show in the editor, is used by GetToolTipText and anything else that will get a native tooltip

Choose your operating system:

Windows

macOS

Linux

References

Module

CoreUObject

Header

/Engine/Source/Runtime/CoreUObject/Public/UObject/Class.h

Include

#include "UObject/Class.h"

Source

/Engine/Source/Runtime/CoreUObject/Private/UObject/Class.cpp

Syntax

static void FormatNativeToolTip
(
    FString & ToolTipString,
    bool bRemoveExtraSections
)

Remarks

Formats a source comment into the form we want to show in the editor, is used by GetToolTipText and anything else that will get a native tooltip

Parameters

Parameter

Description

ToolTipString

String parsed out of C++ headers that is modified in place

bRemoveExtraSections

If true, cut off the comment on first line separator or 2 empty lines in a row