From f6a09be62d4a88ec2f15a4040c3b1e1d9e0e2329 Mon Sep 17 00:00:00 2001
From: Salman Ahmed <frenzibyte@gmail.com>
Date: Sun, 18 Apr 2021 06:35:54 +0300
Subject: [PATCH] Add further xmldoc

---
 osu.Game/Screens/Play/DimmableStoryboard.cs           | 10 ++++++++--
 osu.Game/Storyboards/Drawables/DrawableStoryboard.cs  |  2 +-
 osu.Game/Storyboards/IStoryboardElement.cs            |  8 ++++----
 osu.Game/Storyboards/IStoryboardElementHasDuration.cs |  5 ++++-
 4 files changed, 17 insertions(+), 8 deletions(-)

diff --git a/osu.Game/Screens/Play/DimmableStoryboard.cs b/osu.Game/Screens/Play/DimmableStoryboard.cs
index 73b4153601..f8cedddfbe 100644
--- a/osu.Game/Screens/Play/DimmableStoryboard.cs
+++ b/osu.Game/Screens/Play/DimmableStoryboard.cs
@@ -20,6 +20,14 @@ namespace osu.Game.Screens.Play
         private readonly Storyboard storyboard;
         private DrawableStoryboard drawableStoryboard;
 
+        /// <summary>
+        /// Whether the storyboard is considered finished.
+        /// </summary>
+        /// <remarks>
+        /// This is true by default in here, until an actual drawable storyboard is loaded, in which case it'll bind to it.
+        /// </remarks>
+        public IBindable<bool> HasStoryboardEnded = new BindableBool(true);
+
         public DimmableStoryboard(Storyboard storyboard)
         {
             this.storyboard = storyboard;
@@ -63,7 +71,5 @@ namespace osu.Game.Screens.Play
             Add(storyboard);
             OverlayLayerContainer.Add(storyboard.OverlayLayer.CreateProxy());
         }
-
-        public IBindable<bool> HasStoryboardEnded = new BindableBool(true);
     }
 }
diff --git a/osu.Game/Storyboards/Drawables/DrawableStoryboard.cs b/osu.Game/Storyboards/Drawables/DrawableStoryboard.cs
index abfb4598ec..a9a8b8a4ac 100644
--- a/osu.Game/Storyboards/Drawables/DrawableStoryboard.cs
+++ b/osu.Game/Storyboards/Drawables/DrawableStoryboard.cs
@@ -91,7 +91,7 @@ namespace osu.Game.Storyboards.Drawables
         }
 
         /// <summary>
-        /// Whether the storyboard has ended after the gameplay portion of the beatmap.
+        /// Whether the storyboard is considered finished.
         /// </summary>
         public IBindable<bool> HasStoryboardEnded => hasStoryboardEnded;
 
diff --git a/osu.Game/Storyboards/IStoryboardElement.cs b/osu.Game/Storyboards/IStoryboardElement.cs
index 377ad57ab2..2f05e92070 100644
--- a/osu.Game/Storyboards/IStoryboardElement.cs
+++ b/osu.Game/Storyboards/IStoryboardElement.cs
@@ -18,13 +18,13 @@ namespace osu.Game.Storyboards
     public static class StoryboardElementExtensions
     {
         /// <summary>
-        /// Returns the end time of this object.
+        /// Returns the end time of this storyboard element.
         /// </summary>
         /// <remarks>
         /// This returns the <see cref="IStoryboardElementHasDuration.EndTime"/> where available, falling back to <see cref="IStoryboardElement.StartTime"/> otherwise.
         /// </remarks>
-        /// <param name="storyboardElement">The object.</param>
-        /// <returns>The end time of this object.</returns>
-        public static double GetEndTime(this IStoryboardElement storyboardElement) => (storyboardElement as IStoryboardElementHasDuration)?.EndTime ?? storyboardElement.StartTime;
+        /// <param name="element">The storyboard element.</param>
+        /// <returns>The end time of this element.</returns>
+        public static double GetEndTime(this IStoryboardElement element) => (element as IStoryboardElementHasDuration)?.EndTime ?? element.StartTime;
     }
 }
diff --git a/osu.Game/Storyboards/IStoryboardElementHasDuration.cs b/osu.Game/Storyboards/IStoryboardElementHasDuration.cs
index daa0c55704..b8d3b66694 100644
--- a/osu.Game/Storyboards/IStoryboardElementHasDuration.cs
+++ b/osu.Game/Storyboards/IStoryboardElementHasDuration.cs
@@ -4,10 +4,13 @@
 namespace osu.Game.Storyboards
 {
     /// <summary>
-    /// A StoryboardElement that ends at a different time than its start time.
+    /// A <see cref="IStoryboardElement"/> that ends at a different time than its start time.
     /// </summary>
     public interface IStoryboardElementHasDuration
     {
+        /// <summary>
+        /// The time at which the <see cref="IStoryboardElement"/> ends.
+        /// </summary>
         double EndTime { get; }
     }
 }