Fix minor doc issues
This commit is contained in:
@@ -142,7 +142,7 @@ namespace FlaxEngine
|
|||||||
|
|
||||||
private static string FilterWhitespaces(string str)
|
private static string FilterWhitespaces(string str)
|
||||||
{
|
{
|
||||||
if (str.Contains(" ", StringComparison.Ordinal))
|
if (str != null && str.Contains(" ", StringComparison.Ordinal))
|
||||||
{
|
{
|
||||||
if (_sb == null)
|
if (_sb == null)
|
||||||
_sb = new StringBuilder();
|
_sb = new StringBuilder();
|
||||||
|
|||||||
@@ -13,8 +13,6 @@ API_CLASS(Static, Attributes="DebugCommand") class FLAXENGINE_API Globals
|
|||||||
DECLARE_SCRIPTING_TYPE_NO_SPAWN(Globals);
|
DECLARE_SCRIPTING_TYPE_NO_SPAWN(Globals);
|
||||||
|
|
||||||
public:
|
public:
|
||||||
// Paths
|
|
||||||
|
|
||||||
// Main engine directory path.
|
// Main engine directory path.
|
||||||
API_FIELD(ReadOnly) static String StartupFolder;
|
API_FIELD(ReadOnly) static String StartupFolder;
|
||||||
|
|
||||||
@@ -54,8 +52,6 @@ public:
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
public:
|
public:
|
||||||
// State
|
|
||||||
|
|
||||||
// True if fatal error occurred (engine is exiting).
|
// True if fatal error occurred (engine is exiting).
|
||||||
// [Deprecated in v1.10]
|
// [Deprecated in v1.10]
|
||||||
DEPRECATED("Use Engine::FatalError instead.") static bool FatalErrorOccurred;
|
DEPRECATED("Use Engine::FatalError instead.") static bool FatalErrorOccurred;
|
||||||
@@ -91,14 +87,10 @@ public:
|
|||||||
DEPRECATED("Use Engine::ExitCode instead.") static int32 ExitCode;
|
DEPRECATED("Use Engine::ExitCode instead.") static int32 ExitCode;
|
||||||
|
|
||||||
public:
|
public:
|
||||||
// Threading
|
|
||||||
|
|
||||||
// Main Engine thread id.
|
// Main Engine thread id.
|
||||||
API_FIELD(ReadOnly) static uint64 MainThreadID;
|
API_FIELD(ReadOnly) static uint64 MainThreadID;
|
||||||
|
|
||||||
public:
|
public:
|
||||||
// Config
|
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// The full engine version.
|
/// The full engine version.
|
||||||
/// </summary>
|
/// </summary>
|
||||||
|
|||||||
@@ -19,32 +19,32 @@ public:
|
|||||||
API_FIELD() static bool UseVSync;
|
API_FIELD() static bool UseVSync;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Anti Aliasing quality setting.
|
/// Anti Aliasing quality setting. Available values are: Low, Medium, High, Ultra (or 0, 1, 2, 3).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
API_FIELD() static Quality AAQuality;
|
API_FIELD() static Quality AAQuality;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Screen Space Reflections quality setting.
|
/// Screen Space Reflections quality setting. Available values are: Low, Medium, High, Ultra (or 0, 1, 2, 3).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
API_FIELD() static Quality SSRQuality;
|
API_FIELD() static Quality SSRQuality;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Screen Space Ambient Occlusion quality setting.
|
/// Screen Space Ambient Occlusion quality setting. Available values are: Low, Medium, High, Ultra (or 0, 1, 2, 3).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
API_FIELD() static Quality SSAOQuality;
|
API_FIELD() static Quality SSAOQuality;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// Volumetric Fog quality setting.
|
/// Volumetric Fog quality setting. Available values are: Low, Medium, High, Ultra (or 0, 1, 2, 3).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
API_FIELD() static Quality VolumetricFogQuality;
|
API_FIELD() static Quality VolumetricFogQuality;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// The shadows quality.
|
/// The shadows quality. Available values are: Low, Medium, High, Ultra (or 0, 1, 2, 3).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
API_FIELD() static Quality ShadowsQuality;
|
API_FIELD() static Quality ShadowsQuality;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// The shadow maps quality (textures resolution).
|
/// The shadow maps quality (textures resolution). Available values are: Low, Medium, High, Ultra (or 0, 1, 2, 3).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
API_FIELD() static Quality ShadowMapsQuality;
|
API_FIELD() static Quality ShadowMapsQuality;
|
||||||
|
|
||||||
@@ -59,12 +59,12 @@ public:
|
|||||||
API_FIELD() static bool AllowCSMBlending;
|
API_FIELD() static bool AllowCSMBlending;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// The Global SDF quality. Controls the volume texture resolution and amount of cascades to use.
|
/// The Global SDF quality. Controls the volume texture resolution and amount of cascades to use. Available values are: Low, Medium, High, Ultra (or 0, 1, 2, 3).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
API_FIELD() static Quality GlobalSDFQuality;
|
API_FIELD() static Quality GlobalSDFQuality;
|
||||||
|
|
||||||
/// <summary>
|
/// <summary>
|
||||||
/// The Global Illumination quality. Controls the quality of the GI effect.
|
/// The Global Illumination quality. Controls the quality of the GI effect. Available values are: Low, Medium, High, Ultra (or 0, 1, 2, 3).
|
||||||
/// </summary>
|
/// </summary>
|
||||||
API_FIELD() static Quality GIQuality;
|
API_FIELD() static Quality GIQuality;
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user