From 0ccbd787e48502d9caa990e5683680dda5dbdcaf Mon Sep 17 00:00:00 2001
From: josemgmz <jmgc92@gmail.com>
Date: Mon, 11 Nov 2024 00:48:24 +0100
Subject: [PATCH] docs: CardGridController.cs documentation

---
 .../Entities/CardGrid/CardGridController.cs   | 49 ++++++++++++++-----
 1 file changed, 37 insertions(+), 12 deletions(-)

diff --git a/Assets/Scripts/Game/Entities/CardGrid/CardGridController.cs b/Assets/Scripts/Game/Entities/CardGrid/CardGridController.cs
index c3077b0..ec593ff 100644
--- a/Assets/Scripts/Game/Entities/CardGrid/CardGridController.cs
+++ b/Assets/Scripts/Game/Entities/CardGrid/CardGridController.cs
@@ -10,22 +10,34 @@
 
 namespace Game.Entities.CardGrid
 {
+    /// <summary>
+    /// Controls the card grid, handling the creation and cleanup of the grid.
+    /// </summary>
     public class CardGridController : GameController<GameViewUI>
     {
         #region Lifecycle
 
+        /// <summary>
+        /// Event bus for handling game events.
+        /// </summary>
         [Inject] private IGameEventBus _eventBus;
 
         #endregion
-        
+
         #region Lifecycle Methods
 
+        /// <summary>
+        /// Registers event listeners for setting up and cleaning the grid.
+        /// </summary>
         private void Awake()
         {
             _eventBus.AddListener<OnCardGridSetupEvent>(CreateGrid);
             _eventBus.AddListener<OnRoundEndEvent>(CleanGrid);
         }
-        
+
+        /// <summary>
+        /// Unregisters event listeners when the controller is destroyed.
+        /// </summary>
         private void OnDestroy()
         {
             _eventBus.RemoveListener<OnCardGridSetupEvent>(CreateGrid);
@@ -36,21 +48,25 @@ private void OnDestroy()
 
         #region Methods
 
+        /// <summary>
+        /// Creates the card grid based on the provided event data.
+        /// </summary>
+        /// <param name="eventData">The event data containing grid setup information.</param>
         private void CreateGrid(OnCardGridSetupEvent eventData)
         {
-            //Get model
+            // Get model
             var model = GetModel<CardGridModel>();
             model.ResponsiveGridLayout.SetColumns(eventData.Columns);
             model.ResponsiveGridLayout.SetSpacing(model.Spacing);
-            
-            //Create the grid.
+
+            // Create the grid
             eventData.Cards.ForEach(it =>
             {
                 CreateCard(model.CardPrefab, it);
                 CreateCard(model.CardPrefab, it);
             });
-            
-            //Shuffle the cards
+
+            // Shuffle the cards
             if (!eventData.Shuffle) return;
             var children = new List<Transform>();
             for (var i = 0; i < transform.childCount; i++)
@@ -59,20 +75,29 @@ private void CreateGrid(OnCardGridSetupEvent eventData)
             children.ForEach(it => it.SetSiblingIndex(0));
         }
 
+        /// <summary>
+        /// Creates a card in the grid.
+        /// </summary>
+        /// <param name="cardPrefab">The card prefab to instantiate.</param>
+        /// <param name="it">The event data for setting up the card.</param>
         private void CreateCard(GameObject cardPrefab, OnCardSetupEvent it)
         {
-            //Instantiate the card
+            // Instantiate the card
             var card = Object.Instantiate(cardPrefab, transform);
             card.name = $"Card {it.CardShape.GetString()} {it.CardType.GetString()}";
-                
-            //Get the view and initialize it
+
+            // Get the view and initialize it
             var cardView = card.GetComponent<CardView>();
             cardView.Initialize<CardModel>(it.CardShape, it.CardType, true);
         }
-        
+
+        /// <summary>
+        /// Cleans up the card grid by destroying all child objects.
+        /// </summary>
+        /// <param name="eventData">The event data for ending the round.</param>
         private void CleanGrid(OnRoundEndEvent eventData)
         {
-            //Destroy
+            // Destroy
             for (var i = 0; i < transform.childCount; i++)
                 Object.Destroy(transform.GetChild(i).gameObject);
         }