From a80283ff39cdf2c287d2779170448a0a44a00719 Mon Sep 17 00:00:00 2001
From: Raphael LACOTE <Raphael.LACOTE@etu.uca.fr>
Date: Tue, 3 Jan 2023 15:55:57 +0100
Subject: [PATCH] Ajout de nouveaux commentaires

---
 Sources/Modele/Devises.cs |  3 +++
 Sources/Modele/Hash.cs    | 26 ++++++++++----------
 Sources/Modele/Inscrit.cs | 50 ++++++++++++++++++++++++++++++++++-----
 Sources/Modele/Stub.cs    |  2 --
 4 files changed, 61 insertions(+), 20 deletions(-)

diff --git a/Sources/Modele/Devises.cs b/Sources/Modele/Devises.cs
index aff53dd..68333de 100644
--- a/Sources/Modele/Devises.cs
+++ b/Sources/Modele/Devises.cs
@@ -6,6 +6,9 @@ using System.Threading.Tasks;
 
 namespace Model
 {
+    /// <summary>
+    /// Représente toute les monnaies pouvant être utilisé pour l'application.
+    /// </summary>
     public enum Devises
     {
         Livre_sterling,
diff --git a/Sources/Modele/Hash.cs b/Sources/Modele/Hash.cs
index 2488f66..308edc1 100644
--- a/Sources/Modele/Hash.cs
+++ b/Sources/Modele/Hash.cs
@@ -7,10 +7,17 @@ using System.Text;
 
 namespace Model
 {
+    /// <summary>
+    /// Permet de gérer le hachage des mots de passe à des buts de sécurité.
+    /// </summary>
     public class Hash
     {
+        /// <summary>
+        /// Permet d'obtenir le hachage du mot de passe
+        /// </summary>
+        /// <param name="mdp">Le mot de passe dont on souhaite obtenir le hachage.</param>
+        /// <returns>Le mot de passe haché.</returns>
         public string CreateHashCode(string mdp)
-
         {
             string hashString = "";
             byte[] hash;
@@ -25,21 +32,16 @@ namespace Model
             return hashString;
         }
 
+        /// <summary>
+        /// Permet de vérifier si 2 mots de passe haché sont les mêmes.
+        /// </summary>
+        /// <param name="mdpBdd"> Le mot de passe qui est contenu dans la base de donnée.</param>
+        /// <param name="mdpSent"> Le mot de passe dont on souhaite savoir si il est égale à celui de la base de donnée.</param>
+        /// <returns> Un boolean égale à True si les mots de passe sont égaux. </returns>
         public bool IsEqualHash(string mdpBdd, string mdpSent)
         {
             string hashedMdpSent = CreateHashCode(mdpSent);
             return hashedMdpSent.Equals(mdpBdd);
         }
-
-        private string ByteArrayToString(byte[] arrInput)
-        {
-            int i;
-            StringBuilder sOutput = new StringBuilder(arrInput.Length);
-            for (i = 0; i < arrInput.Length; i++)
-            {
-                sOutput.Append(arrInput[i].ToString("X2"));
-            }
-            return sOutput.ToString();
-        }
     }
 }
diff --git a/Sources/Modele/Inscrit.cs b/Sources/Modele/Inscrit.cs
index 7e05712..a4bd31a 100644
--- a/Sources/Modele/Inscrit.cs
+++ b/Sources/Modele/Inscrit.cs
@@ -9,13 +9,29 @@ using System.Threading.Tasks;
 
 namespace Model
 {
+    /// <summary>
+    /// Permet de représenter une personne inscrit à l'application.
+    /// </summary>
     public class Inscrit
     {
-        public Hash hash = new Hash();
-
+        /// <summary>
+        /// Représente l'identifiant de l'inscrit.
+        /// </summary>
         public string Id { get; private set; }
+
+        /// <summary>
+        /// Représente le prénom de l'inscrit.
+        /// </summary>
+        public string Prenom { get; private set; }
+
+        /// <summary>
+        /// Représente le nom de l'inscrit.
+        /// </summary>
         public string Nom { get; private set; }
 
+        /// <summary>
+        /// Représente l'adresse mail de l'inscrit.
+        /// </summary>
         public string Mail
         {
             get => mail;
@@ -34,8 +50,9 @@ namespace Model
         }
         private string mail;
 
-        public string Prenom { get; private set; }
-
+        /// <summary>
+        /// Représente le mot de passe de l'inscrit pour se connecter à son compte.
+        /// </summary>
         public string Mdp
         {
             get => mdp;
@@ -58,8 +75,19 @@ namespace Model
         }
         private string mdp;
 
+        /// <summary>
+        /// Représente la solde total de l'inscrit.
+        /// </summary>
         public double SoldeTotal { get; private set; }
+
+        /// <summary>
+        /// Type de monnaie pour laquel est le solde total.
+        /// </summary>
         public Devises Dev { get; private set; }
+
+        /// <summary>
+        /// Liste des banques pour laquel l'inscrit à un compte.
+        /// </summary>
         public List<Banque> LesBanques { get; private set; } = new List<Banque>();
 
         public Inscrit(string id, string nom, string mail, string prenom, string mdp, double soldeTotal = 0)
@@ -77,19 +105,29 @@ namespace Model
             LesBanques = lesbanques;
         }
 
-     
-
+        /// <summary>
+        /// Permet d'ajouter une banque à la liste LesBanques
+        /// </summary>
+        /// <param name="banque">objet de type banque correspondant à la banque qui doit être rajouté dans la liste</param>
         public void ajouterBanque(Banque banque)
         {
             LesBanques.Add(banque);
         }
 
+        /// <summary>
+        /// Permet de supprimer une banque de la liste LesBanques
+        /// </summary>
+        /// <param name="banque"> Objet de type banque correspondant à la banque qui doit être supprimé de la liste.</param>
         public void SupprimerBanque(Banque banque)
         {
             LesBanques.Remove(banque);
 
         }
 
+        /// <summary>
+        /// Permet de changer la devise utilisé pour le solde total
+        /// </summary>
+        /// <param name="devise">Correspond à la devise devant être utilisé.</param>
         public void ChoisirDevise(Devises devise)
         {
             Dev = devise;
diff --git a/Sources/Modele/Stub.cs b/Sources/Modele/Stub.cs
index 68afd66..9f42a71 100644
--- a/Sources/Modele/Stub.cs
+++ b/Sources/Modele/Stub.cs
@@ -11,8 +11,6 @@ namespace Model
         public List<Banque> Banques = new();
         public List<Inscrit> Inscrits = new();
         public List<Compte> Comptes = new();
-        //
-
 
         // ajouter load all pour tout les inscrits