From 61f4a5e918b293b3953685f2a0f97e43b88d166d Mon Sep 17 00:00:00 2001
From: "camille.turpin-etienne" <camille.turpin-etienne@etu.uca.fr>
Date: Fri, 10 May 2024 17:35:37 +0200
Subject: [PATCH] Ajout de la doc pour la Couleurs, Indicateur, IRegles, Jeton,
 Joueur

---
 Sources/CoreLibrary/Couleur.cs    |  3 ++
 Sources/CoreLibrary/IRegles.cs    | 55 +++++++++++++++++++++++++++++++
 Sources/CoreLibrary/Indicateur.cs |  3 ++
 Sources/CoreLibrary/Jeton.cs      | 10 ++++++
 Sources/CoreLibrary/Joueur.cs     | 14 ++++++++
 5 files changed, 85 insertions(+)

diff --git a/Sources/CoreLibrary/Couleur.cs b/Sources/CoreLibrary/Couleur.cs
index 214cd87..ce25820 100644
--- a/Sources/CoreLibrary/Couleur.cs
+++ b/Sources/CoreLibrary/Couleur.cs
@@ -1,5 +1,8 @@
 namespace CoreLibrary
 {
+    /// <summary>
+    /// Représente les couleurs disponible pour les jetons.
+    /// </summary>
     public enum Couleur
     {
         ROUGE,
diff --git a/Sources/CoreLibrary/IRegles.cs b/Sources/CoreLibrary/IRegles.cs
index 7c5c389..8f20344 100644
--- a/Sources/CoreLibrary/IRegles.cs
+++ b/Sources/CoreLibrary/IRegles.cs
@@ -1,25 +1,80 @@
 namespace CoreLibrary
 {
+    /// <summary>
+    /// Interface définissant les règles du jeu.
+    /// </summary>
     public interface IRegles
     {
+        /// <summary>
+        /// Obtient le nom des règles du jeu.
+        /// </summary>
         string Nom { get; }
 
+        /// <summary>
+        /// Obtient le nombre de maximum de tours. 
+        /// </summary>
         int TourMaximum { get; }
+
+        /// <summary>
+        /// Obtient la taille maximal du code.
+        /// </summary>
         int TailleCodeMaximum { get; }
 
+        /// <summary>
+        /// Obtient le nombre de joueurs actuels.
+        /// </summary>
         int NbJoueurs { get; }
+
+        /// <summary>
+        /// Obtient le nombre de maximum de joueurs.
+        /// </summary>
         int NbJoueursMaximum { get; }
 
+        /// <summary>
+        /// Ajoute un joueur avec le nom spécifié.
+        /// </summary>
+        /// <param name="nom">Nom du joueur à ajouter</param>
+        /// <returns>Le joueur ajouté.</returns>
         Joueur AjouterJoueur(string nom);
+
+        /// <summary>
+        /// Récupère le joueur courant.
+        /// </summary>
+        /// <returns>Le joueur courant.</returns>
         Joueur JoueurCourant();
+
+        /// <summary>
+        /// Passe la main au joueur suivant.
+        /// </summary>
         void PasserLaMain();
 
+        /// <summary>
+        /// Génère un code selon les règles du jeu.
+        /// </summary>
+        /// <returns>Le code généré.</returns>
         Code GenererCode();
 
+        /// <summary>
+        /// Initialise le premier joueur à jouer.
+        /// </summary>
         void CommencerLaPartie();
+
+        /// <summary>
+        /// Vérifie si la partie est terminée.
+        /// </summary>
+        /// <returns>True si la partie est terminée, sinon False.</returns>
         bool EstTerminee();
 
+        /// <summary>
+        /// Récupère les joueurs gagnants.
+        /// </summary>
+        /// <returns>Enumération des joueurs gagnants.</returns>
         IEnumerable<Joueur> Gagnants();
+
+        /// <summary>
+        /// Récupère les joueurs perdants.
+        /// </summary>
+        /// <returns>Enumération des joueurs perdants.</returns>
         IEnumerable<Joueur> Perdants();
     }
 }
diff --git a/Sources/CoreLibrary/Indicateur.cs b/Sources/CoreLibrary/Indicateur.cs
index 05e3689..d26b5da 100644
--- a/Sources/CoreLibrary/Indicateur.cs
+++ b/Sources/CoreLibrary/Indicateur.cs
@@ -1,5 +1,8 @@
 namespace CoreLibrary
 {
+    /// <summary>
+    /// Représente les couleurs disponibles pour les indicateurs.
+    /// </summary>
     public enum Indicateur
     {
         BONNEPLACE,
diff --git a/Sources/CoreLibrary/Jeton.cs b/Sources/CoreLibrary/Jeton.cs
index b115aa2..9940127 100644
--- a/Sources/CoreLibrary/Jeton.cs
+++ b/Sources/CoreLibrary/Jeton.cs
@@ -1,9 +1,19 @@
 namespace CoreLibrary
 {
+    /// <summary>
+    /// Représente un jetons de couleur.
+    /// </summary>
     public struct Jeton
     {
+        /// <summary>
+        /// Obtient la couleur du jeton.
+        /// </summary>
         public readonly Couleur Couleur { get; private init; }
 
+        /// <summary>
+        /// Initialise une nouvelle instance de la structure Jeton avec la couleur spécifiée.
+        /// </summary>
+        /// <param name="couleur">La couleur du jeton.</param>
         public Jeton(Couleur couleur)
         {
             Couleur = couleur;
diff --git a/Sources/CoreLibrary/Joueur.cs b/Sources/CoreLibrary/Joueur.cs
index 48a1bbb..e8463bd 100644
--- a/Sources/CoreLibrary/Joueur.cs
+++ b/Sources/CoreLibrary/Joueur.cs
@@ -1,10 +1,24 @@
 namespace CoreLibrary
 {
+    /// <summary>
+    /// Représente un joueur.
+    /// </summary>
     public class Joueur
     {
+        /// <summary>
+        /// Obtient le nom du joueur.
+        /// </summary>
         public string Nom { get; private init; }
+        /// <summary>
+        /// Obtient le plateau du joueur.
+        /// </summary>
         public Plateau Plateau { get; private init; }
 
+        /// <summary>
+        /// Crée une nouvelle instance de joueur avec un nom et un plateau spécifié. 
+        /// </summary>
+        /// <param name="nom">Le nom du joueur</param>
+        /// <param name="plateau">Le plateau du joueur</param>
         public Joueur(string nom, Plateau plateau)
         {
             Nom = nom;