From 169acb42de35e88c8755a5140808cb3563cfb97d Mon Sep 17 00:00:00 2001
From: smoogipoo <smoogipoo@smgi.me>
Date: Wed, 10 Feb 2021 20:11:36 +0900
Subject: [PATCH] Xmldoc + cleanup

---
 .../Configuration/ModSettingChangeTracker.cs  | 21 +++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

diff --git a/osu.Game/Configuration/ModSettingChangeTracker.cs b/osu.Game/Configuration/ModSettingChangeTracker.cs
index f702a2fc22..e2ade7dc6a 100644
--- a/osu.Game/Configuration/ModSettingChangeTracker.cs
+++ b/osu.Game/Configuration/ModSettingChangeTracker.cs
@@ -9,12 +9,25 @@ using osu.Game.Rulesets.Mods;
 
 namespace osu.Game.Configuration
 {
+    /// <summary>
+    /// A helper class for tracking changes to the settings of a set of <see cref="Mod"/>s.
+    /// </summary>
+    /// <remarks>
+    /// Ensure to dispose when usage is finished.
+    /// </remarks>
     public class ModSettingChangeTracker : IDisposable
     {
+        /// <summary>
+        /// Notifies that the setting of a <see cref="Mod"/> has changed.
+        /// </summary>
         public Action<Mod> SettingChanged;
 
-        private readonly List<ISettingsItem> references = new List<ISettingsItem>();
+        private readonly List<ISettingsItem> settings = new List<ISettingsItem>();
 
+        /// <summary>
+        /// Creates a new <see cref="ModSettingChangeTracker"/> for a set of <see cref="Mod"/>s.
+        /// </summary>
+        /// <param name="mods">The set of <see cref="Mod"/>s whose settings need to be tracked.</param>
         public ModSettingChangeTracker(IEnumerable<Mod> mods)
         {
             foreach (var mod in mods)
@@ -22,7 +35,7 @@ namespace osu.Game.Configuration
                 foreach (var setting in mod.CreateSettingsControls().OfType<ISettingsItem>())
                 {
                     setting.SettingChanged += () => SettingChanged?.Invoke(mod);
-                    references.Add(setting);
+                    settings.Add(setting);
                 }
             }
         }
@@ -31,9 +44,9 @@ namespace osu.Game.Configuration
         {
             SettingChanged = null;
 
-            foreach (var r in references)
+            foreach (var r in settings)
                 r.Dispose();
-            references.Clear();
+            settings.Clear();
         }
     }
 }