Improve commenting around IHasCombo interfaces

Following discusion with smoogi IRL.
ppy · Nov 22, 2023 · 04640b6 · 04640b6
1 parent 7bdee96
commit 04640b6
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/osu.Game/Rulesets/Objects/Types/IHasCombo.cs b/osu.Game/Rulesets/Objects/Types/IHasCombo.cs
@@ -16,6 +16,12 @@ public interface IHasCombo
         /// <summary>
         /// When starting a new combo, the offset of the new combo relative to the current one.
         /// </summary>
+        /// <remarks>
+        /// This is generally a setting provided by a beatmap creator to choreograph interesting colour patterns
+        /// which can only be achieved by skipping combo colours with per-hitobject level.
+        ///
+        /// It is exposed via <see cref="IHasComboInformation.ComboIndexWithOffsets"/>.
+        /// </remarks>
         int ComboOffset { get; }
     }
 }
diff --git a/osu.Game/Rulesets/Objects/Types/IHasComboInformation.cs b/osu.Game/Rulesets/Objects/Types/IHasComboInformation.cs
@@ -12,20 +12,31 @@ namespace osu.Game.Rulesets.Objects.Types
     /// </summary>
     public interface IHasComboInformation : IHasCombo
     {
+        /// <summary>
+        /// Bindable exposure of <see cref="IndexInCurrentCombo"/>.
+        /// </summary>
         Bindable<int> IndexInCurrentComboBindable { get; }
 
         /// <summary>
         /// The index of this hitobject in the current combo.
         /// </summary>
         int IndexInCurrentCombo { get; set; }
 
+        /// <summary>
+        /// Bindable exposure of <see cref="ComboIndex"/>.
+        /// </summary>
         Bindable<int> ComboIndexBindable { get; }
 
         /// <summary>
         /// The index of this combo in relation to the beatmap.
+        ///
+        /// In other words, this is incremented by 1 each time a <see cref="NewCombo"/> is reached.
         /// </summary>
         int ComboIndex { get; set; }
 
+        /// <summary>
+        /// Bindable exposure of <see cref="ComboIndexWithOffsets"/>.
+        /// </summary>
         Bindable<int> ComboIndexWithOffsetsBindable { get; }
 
         /// <summary>
@@ -39,6 +50,9 @@ public interface IHasComboInformation : IHasCombo
         /// </summary>
         new bool NewCombo { get; set; }
 
+        /// <summary>
+        /// Bindable exposure of <see cref="LastInCombo"/>.
+        /// </summary>
         Bindable<bool> LastInComboBindable { get; }
 
         /// <summary>