From ffbd8aba48b56df15ffee03cd40573a588404078 Mon Sep 17 00:00:00 2001
From: rportet <remy@portet.org>
Date: Sat, 8 Jun 2024 18:46:09 +0200
Subject: [PATCH] adding a lil more doc again

---
 Qwirkle/QwirkleClassLibrary/Games/IRules.cs        | 2 +-
 Qwirkle/QwirkleClassLibrary/Players/Leaderboard.cs | 3 +++
 Qwirkle/QwirkleClassLibrary/Players/Player.cs      | 3 +++
 Qwirkle/QwirkleClassLibrary/Players/Score.cs       | 3 +++
 Qwirkle/QwirkleClassLibrary/Tiles/Tile.cs          | 3 +++
 Qwirkle/QwirkleClassLibrary/Tiles/TileBag.cs       | 3 +++
 6 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/Qwirkle/QwirkleClassLibrary/Games/IRules.cs b/Qwirkle/QwirkleClassLibrary/Games/IRules.cs
index 98f3130..ad64a82 100644
--- a/Qwirkle/QwirkleClassLibrary/Games/IRules.cs
+++ b/Qwirkle/QwirkleClassLibrary/Games/IRules.cs
@@ -10,7 +10,7 @@ using QwirkleClassLibrary.Tiles;
 namespace QwirkleClassLibrary.Games
 {
     /// <summary>
-    /// This interface is used to define the functions used in the game. It is mainly about all the rules of the games, chacking if the player moves are correct.
+    /// This interface is used to define the functions used in the game. It is mainly about all the rules of the games, checking if the player moves are correct.
     /// </summary>
     public interface IRules
     {
diff --git a/Qwirkle/QwirkleClassLibrary/Players/Leaderboard.cs b/Qwirkle/QwirkleClassLibrary/Players/Leaderboard.cs
index d85d4ee..9b4f606 100644
--- a/Qwirkle/QwirkleClassLibrary/Players/Leaderboard.cs
+++ b/Qwirkle/QwirkleClassLibrary/Players/Leaderboard.cs
@@ -12,6 +12,9 @@ using System.Threading.Tasks;
 
 namespace QwirkleClassLibrary.Players
 {
+    /// <summary>
+    /// The purpose of this class is to save data at the end of a game so players can consult it later, comparing their best scores along their games.
+    /// </summary>
     [DataContract]
     public class Leaderboard : INotifyPropertyChanged
     {
diff --git a/Qwirkle/QwirkleClassLibrary/Players/Player.cs b/Qwirkle/QwirkleClassLibrary/Players/Player.cs
index 432ae2f..b872483 100644
--- a/Qwirkle/QwirkleClassLibrary/Players/Player.cs
+++ b/Qwirkle/QwirkleClassLibrary/Players/Player.cs
@@ -12,6 +12,9 @@ using QwirkleClassLibrary.Tiles;
 
 namespace QwirkleClassLibrary.Players
 {
+    /// <summary>
+    /// This class is mainly used to manage the sets of tiles of players during the game.
+    /// </summary>
     [DataContract]
     public class Player : INotifyPropertyChanged
     {
diff --git a/Qwirkle/QwirkleClassLibrary/Players/Score.cs b/Qwirkle/QwirkleClassLibrary/Players/Score.cs
index d8f193b..373564d 100644
--- a/Qwirkle/QwirkleClassLibrary/Players/Score.cs
+++ b/Qwirkle/QwirkleClassLibrary/Players/Score.cs
@@ -9,6 +9,9 @@ using System.Threading.Tasks;
 
 namespace QwirkleClassLibrary.Players
 {
+    /// <summary>
+    /// The main purpose of this class is to save the data of the scores during the games, allowing the app to back up data.
+    /// </summary>
     [DataContract]
     public class Score
     {
diff --git a/Qwirkle/QwirkleClassLibrary/Tiles/Tile.cs b/Qwirkle/QwirkleClassLibrary/Tiles/Tile.cs
index 4c72ccf..4241b33 100644
--- a/Qwirkle/QwirkleClassLibrary/Tiles/Tile.cs
+++ b/Qwirkle/QwirkleClassLibrary/Tiles/Tile.cs
@@ -8,6 +8,9 @@ using System.Threading.Tasks;
 
 namespace QwirkleClassLibrary.Tiles
 {
+    /// <summary>
+    /// This is the class for the Tile, it defines what it is and what can be done with it.
+    /// </summary>
     [DataContract]
     public class Tile : IComparable
     {
diff --git a/Qwirkle/QwirkleClassLibrary/Tiles/TileBag.cs b/Qwirkle/QwirkleClassLibrary/Tiles/TileBag.cs
index 7e17b3a..902ce6a 100644
--- a/Qwirkle/QwirkleClassLibrary/Tiles/TileBag.cs
+++ b/Qwirkle/QwirkleClassLibrary/Tiles/TileBag.cs
@@ -8,6 +8,9 @@ using System.Threading.Tasks;
 
 namespace QwirkleClassLibrary.Tiles
 {
+    /// <summary>
+    /// This class is used during the game for the tile redistribution system. 
+    /// </summary>
     [DataContract]
     public class TileBag
     {