From 1f48378ce72b4036601eb09d0a6090ba51434d38 Mon Sep 17 00:00:00 2001
From: Justus Franklin Tumacder <justusft@gmail.com>
Date: Sun, 25 Apr 2021 08:53:45 +0800
Subject: [PATCH] Add xmldoc to SnapFinder

---
 osu.Game/Rulesets/Objects/SnapFinder.cs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/osu.Game/Rulesets/Objects/SnapFinder.cs b/osu.Game/Rulesets/Objects/SnapFinder.cs
index eb8f4110a2..f915d41305 100644
--- a/osu.Game/Rulesets/Objects/SnapFinder.cs
+++ b/osu.Game/Rulesets/Objects/SnapFinder.cs
@@ -8,10 +8,17 @@ using osu.Game.Beatmaps.ControlPoints;
 
 namespace osu.Game.Rulesets.Objects
 {
+    /// <summary>
+    /// Used to find the lowest beat divisor that a <see cref="HitObject"/> aligns to in an <see cref="IBeatmap"/>
+    /// </summary>
     public class SnapFinder
     {
         private readonly IBeatmap beatmap;
 
+        /// <summary>
+        /// Creates a new SnapFinder instance.
+        /// </summary>
+        /// <param name="beatmap">The beatmap to align to when evaulating.</param>
         public SnapFinder(IBeatmap beatmap)
         {
             this.beatmap = beatmap;
@@ -19,6 +26,10 @@ namespace osu.Game.Rulesets.Objects
 
         private readonly static int[] snaps = { 1, 2, 3, 4, 6, 8, 12, 16 };
 
+        /// <summary>
+        /// Finds the lowest beat divisor that the given HitObject aligns to.
+        /// </summary>
+        /// <param name="hitObject">The <see cref="HitObject"/> to evaluate.</param>
         public int FindSnap(HitObject hitObject)
         {
             TimingControlPoint currentTimingPoint = beatmap.ControlPointInfo.TimingPointAt(hitObject.StartTime);