From 9ec52a354df42ea6f05e088d9bca9a958cf540a7 Mon Sep 17 00:00:00 2001
From: "pauline.prady" <pauline.prady@etu.uca.fr>
Date: Tue, 4 Jun 2024 13:59:23 +0200
Subject: [PATCH] Documentation Persistance

---
 .../CoreLibrary/Persistance/IEstPersistant.cs |  3 +++
 .../CoreLibrary/Persistance/IPersistance.cs   | 11 ++++++++
 .../Persistance/PersistanceJSON.cs            | 25 +++++++++++++++++++
 3 files changed, 39 insertions(+)

diff --git a/Sources/CoreLibrary/Persistance/IEstPersistant.cs b/Sources/CoreLibrary/Persistance/IEstPersistant.cs
index 2e0128e..3a4c8df 100644
--- a/Sources/CoreLibrary/Persistance/IEstPersistant.cs
+++ b/Sources/CoreLibrary/Persistance/IEstPersistant.cs
@@ -1,4 +1,7 @@
 namespace CoreLibrary.Persistance
 {
+    /// <summary>
+    /// Interface IEstPersistant.
+    /// </summary>
     public interface IEstPersistant;
 }
diff --git a/Sources/CoreLibrary/Persistance/IPersistance.cs b/Sources/CoreLibrary/Persistance/IPersistance.cs
index d3ebed8..a15bf3e 100644
--- a/Sources/CoreLibrary/Persistance/IPersistance.cs
+++ b/Sources/CoreLibrary/Persistance/IPersistance.cs
@@ -1,9 +1,20 @@
 namespace CoreLibrary.Persistance
 {
+    /// <summary>
+    /// Interface IPersistance permettant de charger et d'enregistrer.
+    /// </summary>
     public interface IPersistance
     {
+        /// <summary>
+        /// Charge les objets qui lui sont donnés.
+        /// </summary>
+        /// <returns>Renvoie un tableau.</returns>
         public T[] Charger<T>() where T : IEstPersistant;
 
+        /// <summary>
+        /// Enregistre les elements qui lui sont spécifiés.
+        /// </summary>
+        /// <param name="elements">Tableau d'élements à enregistrer.</param>
         public void Enregistrer<T>(T[] elements) where T : IEstPersistant;
     }
 }
diff --git a/Sources/CoreLibrary/Persistance/PersistanceJSON.cs b/Sources/CoreLibrary/Persistance/PersistanceJSON.cs
index 1640fde..419ae9c 100644
--- a/Sources/CoreLibrary/Persistance/PersistanceJSON.cs
+++ b/Sources/CoreLibrary/Persistance/PersistanceJSON.cs
@@ -4,18 +4,39 @@ using System.Xml;
 
 namespace CoreLibrary.Persistance
 {
+    /// <summary>
+    /// Classe PersistanceJSON, implémentant l'interface IPersistance.
+    /// </summary>
     public class PersistanceJSON : IPersistance
     {
+        /// <summary>
+        /// Chaîne de caractères représentant le nom du dossier pour sauvegarder et charger.
+        /// </summary>
         private readonly string nomDossier = "Fichiers";
+
+        /// <summary>
+        /// Chaîne de caractères représentant le nom du doissier à la racine.
+        /// </summary>
         private readonly string nomRacine = "Sources";
+
+        /// <summary>
+        /// Chaîne de caractères représentant le nom du dossier courant.
+        /// </summary>
         private readonly string dossier = AppDomain.CurrentDomain.BaseDirectory;
 
+        /// <summary>
+        /// Constructeur de PersistanceJSON.
+        /// </summary>
         public PersistanceJSON()
         {
             while (new DirectoryInfo(dossier).Name != nomRacine)
                 dossier = Path.GetFullPath(Path.Combine(dossier, @"../"));
         }
 
+        /// <summary>
+        /// Charge les données trouvés dans le fichier de sauvegarde.
+        /// </summary>
+        /// <returns>Renvoie un tableau de tous les éléments chargés.</returns>
         public T[] Charger<T>() where T : IEstPersistant
         {
             string fichier = $"{typeof(T).Name.ToLower()}s.json";
@@ -41,6 +62,10 @@ namespace CoreLibrary.Persistance
             return elements;
         }
 
+        /// <summary>
+        /// Enragistre dans le fichier de sauvegarde, les éléments spécifiés.
+        /// </summary>
+        /// <param name="elements">Elements à enregistrer dans le fichier de sauvegarde.</param>
         public void Enregistrer<T>(T[] elements) where T : IEstPersistant
         {
             string fichier = $"{typeof(T).Name.ToLower()}s.json";