From cb1e2e3d9785748718a37c43f4b01c8e9c704342 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= <dach.bartlomiej@gmail.com>
Date: Mon, 14 Jun 2021 21:51:32 +0200
Subject: [PATCH] Improve xmldoc

---
 .../Rulesets/UI/Scrolling/ScrollingHitObjectContainer.cs  | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/osu.Game/Rulesets/UI/Scrolling/ScrollingHitObjectContainer.cs b/osu.Game/Rulesets/UI/Scrolling/ScrollingHitObjectContainer.cs
index d75954d77f..94cc7ed095 100644
--- a/osu.Game/Rulesets/UI/Scrolling/ScrollingHitObjectContainer.cs
+++ b/osu.Game/Rulesets/UI/Scrolling/ScrollingHitObjectContainer.cs
@@ -25,8 +25,12 @@ namespace osu.Game.Rulesets.UI.Scrolling
         private Direction scrollingAxis => direction.Value == ScrollingDirection.Left || direction.Value == ScrollingDirection.Right ? Direction.Horizontal : Direction.Vertical;
 
         /// <summary>
-        /// Whether the scrolling direction is the positive-to-negative direction in the local coordinate.
+        /// The scrolling axis is inverted if objects temporally farther in the future have a smaller position value across the scrolling axis.
         /// </summary>
+        /// <example>
+        /// <see cref="ScrollingDirection.Down"/> is inverted, because given two objects, one of which is at the current time and one of which is 1000ms in the future,
+        /// in the current time instant the future object is spatially above the current object, and therefore has a smaller value of the Y coordinate of its position.
+        /// </example>
         private bool axisInverted => direction.Value == ScrollingDirection.Down || direction.Value == ScrollingDirection.Right;
 
         /// <summary>
@@ -58,7 +62,7 @@ namespace osu.Game.Rulesets.UI.Scrolling
         }
 
         /// <summary>
-        /// Given a position at <paramref name="currentTime"/>, return the time of the object corresponding the position.
+        /// Given a position at <paramref name="currentTime"/>, return the time of the object corresponding to the position.
         /// </summary>
         /// <remarks>
         /// If there are multiple valid time values, one arbitrary time is returned.