Tweak DrawFPS documentation comment

2021-02-26 09:14:16 +01:00
parent fd802e54fb
commit 9ed0ace01e
1 changed files with 4 additions and 1 deletions
--- a/Source/Engine/Engine/Time.h
+++ b/Source/Engine/Engine/Time.h
@@ -121,8 +121,11 @@ public:
    API_FIELD() static float PhysicsFPS;

    /// <summary>
-    /// The target amount of the frames rendered per second (actual game FPS).
+    /// The target amount of the frames rendered per second (target game FPS).
    /// </summary>
+    /// <remarks>
+    /// To get the actual game FPS use <see cref="Engine.FramesPerSecond"/>
+    /// </remarks>
    API_FIELD() static float DrawFPS;

    /// <summary>