Fix minor doc issues

This commit is contained in:
2026-05-13 15:43:44 +02:00
parent 253442abd1
commit 97bcdacd9a
3 changed files with 9 additions and 17 deletions
+1 -1
View File
@@ -142,7 +142,7 @@ namespace FlaxEngine
private static string FilterWhitespaces(string str)
{
if (str.Contains(" ", StringComparison.Ordinal))
if (str != null && str.Contains(" ", StringComparison.Ordinal))
{
if (_sb == null)
_sb = new StringBuilder();
-8
View File
@@ -13,8 +13,6 @@ API_CLASS(Static, Attributes="DebugCommand") class FLAXENGINE_API Globals
DECLARE_SCRIPTING_TYPE_NO_SPAWN(Globals);
public:
// Paths
// Main engine directory path.
API_FIELD(ReadOnly) static String StartupFolder;
@@ -54,8 +52,6 @@ public:
#endif
public:
// State
// True if fatal error occurred (engine is exiting).
// [Deprecated in v1.10]
DEPRECATED("Use Engine::FatalError instead.") static bool FatalErrorOccurred;
@@ -91,14 +87,10 @@ public:
DEPRECATED("Use Engine::ExitCode instead.") static int32 ExitCode;
public:
// Threading
// Main Engine thread id.
API_FIELD(ReadOnly) static uint64 MainThreadID;
public:
// Config
/// <summary>
/// The full engine version.
/// </summary>
+8 -8
View File
@@ -19,32 +19,32 @@ public:
API_FIELD() static bool UseVSync;
/// <summary>
/// Anti Aliasing quality setting.
/// Anti Aliasing quality setting. Available values are: Low, Medium, High, Ultra (or 0, 1, 2, 3).
/// </summary>
API_FIELD() static Quality AAQuality;
/// <summary>
/// Screen Space Reflections quality setting.
/// Screen Space Reflections quality setting. Available values are: Low, Medium, High, Ultra (or 0, 1, 2, 3).
/// </summary>
API_FIELD() static Quality SSRQuality;
/// <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>
API_FIELD() static Quality SSAOQuality;
/// <summary>
/// Volumetric Fog quality setting.
/// Volumetric Fog quality setting. Available values are: Low, Medium, High, Ultra (or 0, 1, 2, 3).
/// </summary>
API_FIELD() static Quality VolumetricFogQuality;
/// <summary>
/// The shadows quality.
/// The shadows quality. Available values are: Low, Medium, High, Ultra (or 0, 1, 2, 3).
/// </summary>
API_FIELD() static Quality ShadowsQuality;
/// <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>
API_FIELD() static Quality ShadowMapsQuality;
@@ -59,12 +59,12 @@ public:
API_FIELD() static bool AllowCSMBlending;
/// <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>
API_FIELD() static Quality GlobalSDFQuality;
/// <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>
API_FIELD() static Quality GIQuality;