From 8d293abd2b54e2277850a7c587a03f31ce3db23b Mon Sep 17 00:00:00 2001
From: "pauline.prady" <pauline.prady@etu.uca.fr>
Date: Mon, 3 Jun 2024 21:59:12 +0200
Subject: [PATCH] Documentation Plateau

---
 Sources/CoreLibrary/Core/Plateau.cs | 57 +++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)

diff --git a/Sources/CoreLibrary/Core/Plateau.cs b/Sources/CoreLibrary/Core/Plateau.cs
index 02a38a4..4991164 100644
--- a/Sources/CoreLibrary/Core/Plateau.cs
+++ b/Sources/CoreLibrary/Core/Plateau.cs
@@ -5,33 +5,80 @@ using System.Security.Cryptography;
 
 namespace CoreLibrary.Core
 {
+    /// <summary>
+    /// Classe représentant le plateau de jeu contenant les codes et les indicateurs.
+    /// </summary>
     [DataContract]
     public class Plateau
     {
+        /// <summary>
+        /// Événement déclenché lorsqu'un code est ajouté au plateau.
+        /// </summary>
         public event EventHandler<PlateauAjouterCodeEventArgs>? PlateauAjouterCode;
 
         private void QuandPlateauAjouterCode() => PlateauAjouterCode?.Invoke(this, new PlateauAjouterCodeEventArgs(this));
 
+        /// <summary>
+        /// Le code secret à deviner.
+        /// </summary>
         [DataMember]
         private readonly Code codeSecret;
+
+        /// <summary>
+        /// Liste des codes ajoutés au plateau.
+        /// </summary>
         [DataMember]
         private readonly List<Code> codes = new List<Code>();
+
+        /// <summary>
+        /// Liste des listes d'indicateurs pour chaque code ajouté.
+        /// </summary>
         [DataMember]
         private readonly List<List<Indicateur>> indicateurs = new List<List<Indicateur>>();
 
+        /// <summary>
+        /// Obtient le nombre de codes sur le plateau.
+        /// </summary>
         public int Taille => codes.Count;
+
+        /// <summary>
+        /// Obtient la taille maximale de codes autorisée sur le plateau.
+        /// </summary>
         [DataMember]
         public int TailleMax { get; private init; }
+
+        /// <summary>
+        /// Obtient la taille maximale d'un code.
+        /// </summary>
         [DataMember]
         public int TailleMaxCode { get; private init; }
+
+        /// <summary>
+        /// Indique si le plateau à atteint sa taille maximale.
+        /// </summary>
         public bool Complet => Taille == TailleMax;
+
+        /// <summary>
+        /// Indique si la victoire est atteinte.
+        /// </summary>
         [DataMember]
         public bool Victoire { get; private set; } = false;
+
+        /// <summary>
+        /// Obtient la grille des codes et des indicateurs.
+        /// </summary>
         public (IReadOnlyList<IReadOnlyList<Jeton>>, IReadOnlyList<IReadOnlyList<Indicateur>>) Grille => (
             codes.Select(code => code.Jetons).ToList(),
             indicateurs
         );
 
+        /// <summary>
+        /// Constructeur de plateau avec une taille de code et une taille de plateau spécifiées.
+        /// </summary>
+        /// <param name="tailleCode">La taille maximale d'un code.</param>
+        /// <param name="taillePlateau">La taille maximale du plateau.</param>
+        /// <exception cref="TailleCodeException">Lancée si la taille du code est négative ou nulle.</exception>
+        /// <exception cref="TailleGrilleException">Lancée si la taille du plateau spécifiée est négative ou nulle.</exception>
         public Plateau(int tailleCode, int taillePlateau)
         {
             if (tailleCode < 0)
@@ -46,6 +93,10 @@ namespace CoreLibrary.Core
             codeSecret = GenererCodeSecret();
         }
 
+        /// <summary>
+        /// Génère un code secret aléatoire.
+        /// </summary>
+        /// <returns>Renvoie le code secret généré.</returns>
         private Code GenererCodeSecret()
         {
             Code code = new Code(TailleMaxCode);
@@ -61,6 +112,12 @@ namespace CoreLibrary.Core
             return code;
         }
 
+        /// <summary>
+        /// Ajoute un code au plateau et compare avec le code secret.
+        /// </summary>
+        /// <param name="code">Le code à ajouter.</param>
+        /// <exception cref="CodeIncompletException">Lancée si le code à ajouter n'est pas complet.</exception>
+        /// <exception cref="GrilleCompleteException">Lancée si le plateau est déjà complet.</exception>
         public void AjouterCode(Code code)
         {
             if (!code.Complet)