From e9339d6100b43c72308862582215c00ff3a2950d Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Tue, 22 Jun 2021 15:16:19 +0900
Subject: [PATCH] Move some inline comments on `const`s to xmldoc instead

---
 .../Edit/Checks/CheckLowDiffOverlaps.cs       |  4 ++-
 .../Edit/Checks/CheckTimeDistanceEquality.cs  | 34 +++++++++++++++----
 2 files changed, 31 insertions(+), 7 deletions(-)

diff --git a/osu.Game.Rulesets.Osu/Edit/Checks/CheckLowDiffOverlaps.cs b/osu.Game.Rulesets.Osu/Edit/Checks/CheckLowDiffOverlaps.cs
index 488bdfd972..1dd859b5b8 100644
--- a/osu.Game.Rulesets.Osu/Edit/Checks/CheckLowDiffOverlaps.cs
+++ b/osu.Game.Rulesets.Osu/Edit/Checks/CheckLowDiffOverlaps.cs
@@ -17,7 +17,9 @@ namespace osu.Game.Rulesets.Osu.Edit.Checks
         private const double should_probably_overlap_threshold = 175; // 170 BPM 1/2
         private const double should_not_overlap_threshold = 250; // 120 BPM 1/2 = 240 BPM 1/1
 
-        // Objects need to overlap this much before being treated as an overlap, else it may just be the borders slightly touching.
+        /// <summary>
+        /// Objects need to overlap this much before being treated as an overlap, else it may just be the borders slightly touching.
+        /// </summary>
         private const double overlap_leniency = 5;
 
         public CheckMetadata Metadata { get; } = new CheckMetadata(CheckCategory.Spread, "Missing or unexpected overlaps");
diff --git a/osu.Game.Rulesets.Osu/Edit/Checks/CheckTimeDistanceEquality.cs b/osu.Game.Rulesets.Osu/Edit/Checks/CheckTimeDistanceEquality.cs
index db48878dd3..6420d9558e 100644
--- a/osu.Game.Rulesets.Osu/Edit/Checks/CheckTimeDistanceEquality.cs
+++ b/osu.Game.Rulesets.Osu/Edit/Checks/CheckTimeDistanceEquality.cs
@@ -14,14 +14,36 @@ namespace osu.Game.Rulesets.Osu.Edit.Checks
 {
     public class CheckTimeDistanceEquality : ICheck
     {
-        private const double pattern_lifetime = 600; // Two objects this many ms apart or more are skipped. (200 BPM 2/1)
-        private const double stack_leniency = 12; // Two objects this distance apart or less are skipped.
+        /// <summary>
+        /// Two objects this many ms apart or more are skipped. (200 BPM 2/1)
+        /// </summary>
+        private const double pattern_lifetime = 600;
 
-        private const double observation_lifetime = 4000; // How long an observation is relevant for comparison. (120 BPM 8/1)
-        private const double similar_time_leniency = 16; // How different two delta times can be to still be compared. (240 BPM 1/16)
+        /// <summary>
+        /// Two objects this distance apart or less are skipped.
+        /// </summary>
+        private const double stack_leniency = 12;
+
+        /// <summary>
+        /// How long an observation is relevant for comparison. (120 BPM 8/1)
+        /// </summary>
+        private const double observation_lifetime = 4000;
+
+        /// <summary>
+        /// How different two delta times can be to still be compared. (240 BPM 1/16)
+        /// </summary>
+        private const double similar_time_leniency = 16;
+
+        /// <summary>
+        /// How many pixels are subtracted from the difference between current and expected distance.
+        /// </summary>
+        private const double distance_leniency_absolute_warning = 10;
+
+        /// <summary>
+        /// How much of the current distance that the difference can make out.
+        /// </summary>
+        private const double distance_leniency_percent_warning = 0.15;
 
-        private const double distance_leniency_absolute_warning = 10; // How many pixels are subtracted from the difference between current and expected distance.
-        private const double distance_leniency_percent_warning = 0.15; // How much of the current distance that the difference can make out.
         private const double distance_leniency_absolute_problem = 20;
         private const double distance_leniency_percent_problem = 0.3;