From 089f3bebf57f3be57c8a1b2e525681a62f8d095a Mon Sep 17 00:00:00 2001
From: ekrctb <ekrctb@gmail.com>
Date: Mon, 14 Dec 2020 11:15:49 +0900
Subject: [PATCH] Add doc comments to catch hit object X properties

---
 osu.Game.Rulesets.Catch/Objects/CatchHitObject.cs | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/osu.Game.Rulesets.Catch/Objects/CatchHitObject.cs b/osu.Game.Rulesets.Catch/Objects/CatchHitObject.cs
index a5c254f2f1..d40821c840 100644
--- a/osu.Game.Rulesets.Catch/Objects/CatchHitObject.cs
+++ b/osu.Game.Rulesets.Catch/Objects/CatchHitObject.cs
@@ -19,6 +19,12 @@ namespace osu.Game.Rulesets.Catch.Objects
 
         public readonly Bindable<float> OriginalXBindable = new Bindable<float>();
 
+        /// <summary>
+        /// The horizontal position of the hit object between 0 and <see cref="CatchPlayfield.WIDTH"/>.
+        /// </summary>
+        /// <remarks>
+        /// This value is the original value specified in the beatmap, not affected by beatmap processing.
+        /// </remarks>
         public float OriginalX
         {
             get => OriginalXBindable.Value;
@@ -37,12 +43,15 @@ namespace osu.Game.Rulesets.Catch.Objects
 
         public readonly Bindable<float> EffectiveXBindable = new Bindable<float>();
 
+        /// <summary>
+        /// The effective horizontal position of the hit object between 0 and <see cref="CatchPlayfield.WIDTH"/>.
+        /// </summary>
         public float EffectiveX => EffectiveXBindable.Value;
 
         private float xOffset;
 
         /// <summary>
-        /// A random offset applied to <see cref="X"/>, set by the <see cref="CatchBeatmapProcessor"/>.
+        /// A random offset applied to the horizontal value, set by the <see cref="CatchBeatmapProcessor"/>.
         /// </summary>
         internal float XOffset
         {