From 2026228b71d3331b44447f6abe8fc044885429fb Mon Sep 17 00:00:00 2001
From: rportet <remy@portet.org>
Date: Sat, 8 Jun 2024 18:28:06 +0200
Subject: [PATCH] adding a lil doc

---
 Qwirkle/QwirkleClassLibrary/Boards/Cell.cs   | 3 +++
 Qwirkle/QwirkleClassLibrary/Games/Game.cs    | 3 +++
 Qwirkle/QwirkleClassLibrary/Games/IPlayer.cs | 3 +++
 Qwirkle/QwirkleClassLibrary/Games/IRules.cs  | 3 +++
 4 files changed, 12 insertions(+)

diff --git a/Qwirkle/QwirkleClassLibrary/Boards/Cell.cs b/Qwirkle/QwirkleClassLibrary/Boards/Cell.cs
index 0f470dc..1100117 100644
--- a/Qwirkle/QwirkleClassLibrary/Boards/Cell.cs
+++ b/Qwirkle/QwirkleClassLibrary/Boards/Cell.cs
@@ -6,6 +6,9 @@ using QwirkleClassLibrary.Tiles;
 
 namespace QwirkleClassLibrary.Boards;
 
+/// <summary>
+/// Our board is made with a list of this class. It can stock infos such as its position on the board and the tile it contains.
+/// </summary>
 [DataContract]
 public class Cell : INotifyPropertyChanged
 {
diff --git a/Qwirkle/QwirkleClassLibrary/Games/Game.cs b/Qwirkle/QwirkleClassLibrary/Games/Game.cs
index d7766a6..7290c56 100644
--- a/Qwirkle/QwirkleClassLibrary/Games/Game.cs
+++ b/Qwirkle/QwirkleClassLibrary/Games/Game.cs
@@ -11,6 +11,9 @@ using static System.Formats.Asn1.AsnWriter;
 
 namespace QwirkleClassLibrary.Games
 {
+    /// <summary>
+    /// This is our main class for the Qwirkle application, taking care of the good efficiency of the game.
+    /// </summary>
     [DataContract]
     public class Game : IPlayer, IRules, INotifyPropertyChanged
     {
diff --git a/Qwirkle/QwirkleClassLibrary/Games/IPlayer.cs b/Qwirkle/QwirkleClassLibrary/Games/IPlayer.cs
index c6642b3..0a54e84 100644
--- a/Qwirkle/QwirkleClassLibrary/Games/IPlayer.cs
+++ b/Qwirkle/QwirkleClassLibrary/Games/IPlayer.cs
@@ -5,6 +5,9 @@ using QwirkleClassLibrary.Tiles;
 
 namespace QwirkleClassLibrary.Games;
 
+/// <summary>
+/// This interface is used for all methods related to the player, such as the moves he can make.
+/// </summary>
 public interface IPlayer
 {
     public Player CreatePlayer(string playerTag);
diff --git a/Qwirkle/QwirkleClassLibrary/Games/IRules.cs b/Qwirkle/QwirkleClassLibrary/Games/IRules.cs
index 7e5b709..98f3130 100644
--- a/Qwirkle/QwirkleClassLibrary/Games/IRules.cs
+++ b/Qwirkle/QwirkleClassLibrary/Games/IRules.cs
@@ -9,6 +9,9 @@ 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.
+    /// </summary>
     public interface IRules
     {
         Board CreateBoard();