From 4b2d971b005bf6e82d84d4969b248bbf55ef32b8 Mon Sep 17 00:00:00 2001
From: smoogipoo <smoogipoo@smgi.me>
Date: Fri, 12 Jan 2018 13:03:47 +0900
Subject: [PATCH] Add some comments

---
 .../Algorithms/IScrollingAlgorithm.cs          | 18 ++++++++++++++++++
 .../Scrolling/ScrollingHitObjectContainer.cs   | 10 +++++++---
 2 files changed, 25 insertions(+), 3 deletions(-)

diff --git a/osu.Game/Rulesets/UI/Scrolling/Algorithms/IScrollingAlgorithm.cs b/osu.Game/Rulesets/UI/Scrolling/Algorithms/IScrollingAlgorithm.cs
index f9863bd299..d9e4ab228f 100644
--- a/osu.Game/Rulesets/UI/Scrolling/Algorithms/IScrollingAlgorithm.cs
+++ b/osu.Game/Rulesets/UI/Scrolling/Algorithms/IScrollingAlgorithm.cs
@@ -9,7 +9,25 @@ namespace osu.Game.Rulesets.UI.Scrolling.Algorithms
 {
     public interface IScrollingAlgorithm
     {
+        /// <summary>
+        /// Computes the states of <see cref="DrawableHitObject"/>s that are constant, such as lifetime and spatial length.
+        /// This is invoked once whenever <paramref name="timeRange"/> or <paramref name="length"/> changes.
+        /// </summary>
+        /// <param name="hitObjects">The <see cref="DrawableHitObject"/>s whose states should be computed.</param>
+        /// <param name="direction">The scrolling direction.</param>
+        /// <param name="timeRange">The duration required to scroll through one length of the screen before any control point adjustments.</param>
+        /// <param name="length">The length of the screen that is scrolled through.</param>
         void ComputeInitialStates(IEnumerable<DrawableHitObject> hitObjects, ScrollingDirection direction, double timeRange, Vector2 length);
+
+        /// <summary>
+        /// Computes the states of <see cref="DrawableHitObject"/>s that change depending on <paramref name="currentTime"/>, such as position.
+        /// This is invoked once per frame.
+        /// </summary>
+        /// <param name="hitObjects">The <see cref="DrawableHitObject"/>s whose states should be computed.</param>
+        /// <param name="direction">The scrolling direction.</param>
+        /// <param name="currentTime">The current time.</param>
+        /// <param name="timeRange">The duration required to scroll through one length of the screen before any control point adjustments.</param>
+        /// <param name="length">The length of the screen that is scrolled through.</param>
         void ComputePositions(IEnumerable<DrawableHitObject> hitObjects, ScrollingDirection direction, double currentTime, double timeRange, Vector2 length);
     }
 }
diff --git a/osu.Game/Rulesets/UI/Scrolling/ScrollingHitObjectContainer.cs b/osu.Game/Rulesets/UI/Scrolling/ScrollingHitObjectContainer.cs
index dfa6a40db4..960fd94762 100644
--- a/osu.Game/Rulesets/UI/Scrolling/ScrollingHitObjectContainer.cs
+++ b/osu.Game/Rulesets/UI/Scrolling/ScrollingHitObjectContainer.cs
@@ -15,12 +15,18 @@ namespace osu.Game.Rulesets.UI.Scrolling
 {
     public class ScrollingHitObjectContainer : HitObjectContainer
     {
+        /// <summary>
+        /// The duration required to scroll through one length of the <see cref="ScrollingHitObjectContainer"/> before any control point adjustments.
+        /// </summary>
         public readonly BindableDouble TimeRange = new BindableDouble
         {
             MinValue = 0,
             MaxValue = double.MaxValue
         };
 
+        /// <summary>
+        /// The control points that adjust the scrolling speed.
+        /// </summary>
         protected readonly SortedList<MultiplierControlPoint> ControlPoints = new SortedList<MultiplierControlPoint>();
 
         private readonly ScrollingDirection direction;
@@ -104,9 +110,7 @@ namespace osu.Game.Rulesets.UI.Scrolling
         {
             base.UpdateAfterChildrenLife();
 
-            // We need to calculate this as soon as possible after lifetimes so that hitobjects
-            // get the final say in their positions
-
+            // We need to calculate this as soon as possible after lifetimes so that hitobjects get the final say in their positions
             scrollingAlgorithm.ComputePositions(AliveObjects, direction, Time.Current, TimeRange, DrawSize);
         }
     }