From 30777795ce2caf73a9a4c8c3da19b79b5f589112 Mon Sep 17 00:00:00 2001
From: ekrctb <ekrctb@gmail.com>
Date: Wed, 21 Jul 2021 16:40:35 +0900
Subject: [PATCH] Add some doc comment to `CatcherArea`

---
 osu.Game.Rulesets.Catch/UI/CatcherArea.cs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/osu.Game.Rulesets.Catch/UI/CatcherArea.cs b/osu.Game.Rulesets.Catch/UI/CatcherArea.cs
index f2c5f96b26..bc0c101805 100644
--- a/osu.Game.Rulesets.Catch/UI/CatcherArea.cs
+++ b/osu.Game.Rulesets.Catch/UI/CatcherArea.cs
@@ -15,6 +15,11 @@ using osuTK;
 
 namespace osu.Game.Rulesets.Catch.UI
 {
+    /// <summary>
+    /// The horizontal band at the bottom of the playfield the catcher is moving on.
+    /// It holds a <see cref="Catcher"/> as a child and translates input to the catcher movement.
+    /// It also holds a combo display that is above the catcher, and judgment results are translated to the catcher and the combo display.
+    /// </summary>
     public class CatcherArea : Container, IKeyBindingHandler<CatchAction>
     {
         public const float CATCHER_SIZE = 106.75f;
@@ -42,6 +47,9 @@ namespace osu.Game.Rulesets.Catch.UI
         /// </summary>
         private int currentDirection;
 
+        /// <remarks>
+        /// <see cref="Catcher"/> must be set before loading.
+        /// </remarks>
         public CatcherArea()
         {
             Size = new Vector2(CatchPlayfield.WIDTH, CATCHER_SIZE);