From a3161bd3e41dde2786b00f1596a602248c189907 Mon Sep 17 00:00:00 2001
From: "pauline.prady" <pauline.prady@etu.uca.fr>
Date: Fri, 7 Jun 2024 16:40:34 +0200
Subject: [PATCH] Documentation des exceptions

---
 Sources/UnitTesting/CodeCompletExceptionUT.cs | 29 +++++++++++----
 .../UnitTesting/CodeIncompletExceptionUT.cs   | 29 +++++++++++----
 .../UnitTesting/CodeInvalideExceptionUT.cs    | 36 ++++++++++++++-----
 Sources/UnitTesting/CodeVideExceptionUT.cs    | 17 ++++++++-
 .../UnitTesting/GrilleCompleteExceptionUT.cs  | 17 ++++++++-
 Sources/UnitTesting/IndiceCodeExceptionUT.cs  | 20 ++++++++++-
 .../JoueurDejaPresentExceptionUT.cs           | 17 ++++++++-
 .../NomJoueurInterditExceptionUT.cs           | 17 ++++++++-
 Sources/UnitTesting/TailleCodeExceptionUT.cs  | 18 ++++++++++
 .../UnitTesting/TailleGrilleExceptionUT.cs    | 36 ++++++++++++++-----
 10 files changed, 199 insertions(+), 37 deletions(-)

diff --git a/Sources/UnitTesting/CodeCompletExceptionUT.cs b/Sources/UnitTesting/CodeCompletExceptionUT.cs
index 0ac5325..6388e59 100644
--- a/Sources/UnitTesting/CodeCompletExceptionUT.cs
+++ b/Sources/UnitTesting/CodeCompletExceptionUT.cs
@@ -7,14 +7,23 @@ using Xunit;
 
 namespace UnitTesting
 {
+    /// <summary>
+    /// Classe de test de l'exception CodeCompletException.
+    /// </summary>
     public class CodeCompletExceptionUT
-    {
+    {
+        /// <summary>
+        /// Test de l'exception CodeCompletException par defaut.
+        /// </summary>
         [Fact]
         public void ExceptionDefaut()
         {
             Assert.ThrowsAsync<CodeCompletException>(() => throw new CodeCompletException());
-        }
-
+        }
+
+        /// <summary>
+        /// Test du message de l'exception CodeCompletException.
+        /// </summary>
         [Fact]
         public void ExceptionMessage()
         {
@@ -30,8 +39,11 @@ namespace UnitTesting
             {
                 Assert.Equal(message, e.Message);
             }
-        }
-
+        }
+
+        /// <summary>
+        /// Test de l'exception CodeCompletException et de ses messages.
+        /// </summary>
         [Fact]
         public void ExceptionMessageEtException()
         {
@@ -52,8 +64,11 @@ namespace UnitTesting
                 Assert.IsType<InvalidOperationException>(e.InnerException);
                 Assert.Equal(message2, e.InnerException.Message);
             }
-        }
-
+        }
+
+        /// <summary>
+        /// Test de la serialisation de l'exception CodeCompletException.
+        /// </summary>
         [Fact]
         public void ExceptionSerialisation()
         {
diff --git a/Sources/UnitTesting/CodeIncompletExceptionUT.cs b/Sources/UnitTesting/CodeIncompletExceptionUT.cs
index 0476bb1..a904f58 100644
--- a/Sources/UnitTesting/CodeIncompletExceptionUT.cs
+++ b/Sources/UnitTesting/CodeIncompletExceptionUT.cs
@@ -5,14 +5,23 @@ using Xunit;
 
 namespace UnitTesting
 {
+    /// <summary>
+    /// Classe de test de l'exception CodeIncompletException.
+    /// </summary>
     public class CodeIncompletExceptionUT
-    {
+    {
+        /// <summary>
+        /// Test de l'exception CodeIncompletException par defaut.
+        /// </summary>
         [Fact]
         public void ExceptionDefaut()
         {
             Assert.ThrowsAsync<CodeIncompletException>(() => throw new CodeIncompletException());
-        }
-
+        }
+
+        /// <summary>
+        /// Test du message de l'exception CodeIncompletException.
+        /// </summary>
         [Fact]
         public void ExceptionMessage()
         {
@@ -28,8 +37,11 @@ namespace UnitTesting
             {
                 Assert.Equal(message, e.Message);
             }
-        }
-
+        }
+
+        /// <summary>
+        /// Test de l'exception CodeIncompletException et de ses messages.
+        /// </summary>
         [Fact]
         public void ExceptionMessageEtException()
         {
@@ -50,8 +62,11 @@ namespace UnitTesting
                 Assert.IsType<InvalidOperationException>(e.InnerException);
                 Assert.Equal(message2, e.InnerException.Message);
             }
-        }
-
+        }
+
+        /// <summary>
+        /// Test de la serialisation de l'exception CodeIncompletException.
+        /// </summary>
         [Fact]
         public void ExceptionSerialisation()
         {
diff --git a/Sources/UnitTesting/CodeInvalideExceptionUT.cs b/Sources/UnitTesting/CodeInvalideExceptionUT.cs
index 87242c6..3d41ea8 100644
--- a/Sources/UnitTesting/CodeInvalideExceptionUT.cs
+++ b/Sources/UnitTesting/CodeInvalideExceptionUT.cs
@@ -5,14 +5,23 @@ using Xunit;
 
 namespace UnitTesting
 {
+    /// <summary>
+    /// Classe de test de l'exception CodeInvalideException.
+    /// </summary>
     public class CodeInvalideExceptionUT
-    {
+    {
+        /// <summary>
+        /// Test de l'exception CodeInvalideException par defaut.
+        /// </summary>
         [Fact]
         public void ExceptionDefaut()
         {
             Assert.ThrowsAsync<CodeInvalideException>(() => throw new CodeInvalideException());
-        }
-
+        }
+
+        /// <summary>
+        /// Test des attributs de l'exception CodeInvalideException.
+        /// </summary>
         [Fact]
         public void ExceptionAttributs()
         {
@@ -27,8 +36,11 @@ namespace UnitTesting
                 Assert.Contains("3", e.Message);
                 Assert.Contains("4", e.Message);
             }
-        }
-
+        }
+
+        /// <summary>
+        /// Test du message de l'exception CodeInvalideException.
+        /// </summary>
         [Fact]
         public void ExceptionMessage()
         {
@@ -44,8 +56,11 @@ namespace UnitTesting
             {
                 Assert.Equal(message, e.Message);
             }
-        }
-
+        }
+
+        /// <summary>
+        /// Test de l'exception CodeInvalideException et de ses messages.
+        /// </summary>
         [Fact]
         public void ExceptionMessageEtException()
         {
@@ -66,8 +81,11 @@ namespace UnitTesting
                 Assert.IsType<InvalidOperationException>(e.InnerException);
                 Assert.Equal(message2, e.InnerException.Message);
             }
-        }
-
+        }
+
+        /// <summary>
+        /// Test de la serialisation de l'exception CodeInvalideException.
+        /// </summary>
         [Fact]
         public void ExceptionSerialisation()
         {
diff --git a/Sources/UnitTesting/CodeVideExceptionUT.cs b/Sources/UnitTesting/CodeVideExceptionUT.cs
index 2ad8544..a77dc77 100644
--- a/Sources/UnitTesting/CodeVideExceptionUT.cs
+++ b/Sources/UnitTesting/CodeVideExceptionUT.cs
@@ -4,15 +4,24 @@ using System.Runtime.Serialization;
 using Xunit;
 
 namespace UnitTesting
-{
+{
+    /// <summary>
+    /// Classe de test de l'exception CodeVideException.
+    /// </summary>
     public class CodeVideExceptionUT
     {
+        /// <summary>
+        /// Test de l'exception CodeVideException par defaut.
+        /// </summary>
         [Fact]
         public void ExceptionDefaut()
         {
             Assert.ThrowsAsync<CodeVideException>(() => throw new CodeVideException());
         }
 
+        /// <summary>
+        /// Test du message de l'exception CodeVideException.
+        /// </summary>
         [Fact]
         public void ExceptionMessage()
         {
@@ -30,6 +39,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test de l'exception CodeVideException et de ses messages.
+        /// </summary>
         [Fact]
         public void ExceptionMessageEtException()
         {
@@ -52,6 +64,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test de la serialisation de l'exception CodeVideException.
+        /// </summary>
         [Fact]
         public void ExceptionSerialisation()
         {
diff --git a/Sources/UnitTesting/GrilleCompleteExceptionUT.cs b/Sources/UnitTesting/GrilleCompleteExceptionUT.cs
index c083a7d..bf4bf99 100644
--- a/Sources/UnitTesting/GrilleCompleteExceptionUT.cs
+++ b/Sources/UnitTesting/GrilleCompleteExceptionUT.cs
@@ -4,15 +4,24 @@ using System.Runtime.Serialization;
 using Xunit;
 
 namespace UnitTesting
-{
+{
+    /// <summary>
+    /// Classe de test de l'exception GrilleCompleteException.
+    /// </summary>
     public class GrilleCompleteExceptionUT
     {
+        /// <summary>
+        /// Test de l'exception GrilleCompleteException par defaut.
+        /// </summary>
         [Fact]
         public void ExceptionDefaut()
         {
             Assert.ThrowsAsync<GrilleCompleteException>(() => throw new GrilleCompleteException());
         }
 
+        /// <summary>
+        /// Test du message de l'exception GrilleCompleteException.
+        /// </summary>
         [Fact]
         public void ExceptionMessage()
         {
@@ -30,6 +39,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test de l'exception GrilleCompleteException et de ses messages.
+        /// </summary>
         [Fact]
         public void ExceptionMessageEtException()
         {
@@ -52,6 +64,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test de la serialisation de l'evenement GrilleCompleteException.
+        /// </summary>
         [Fact]
         public void ExceptionSerialisation()
         {
diff --git a/Sources/UnitTesting/IndiceCodeExceptionUT.cs b/Sources/UnitTesting/IndiceCodeExceptionUT.cs
index a14c524..d311d7f 100644
--- a/Sources/UnitTesting/IndiceCodeExceptionUT.cs
+++ b/Sources/UnitTesting/IndiceCodeExceptionUT.cs
@@ -4,15 +4,24 @@ using System.Runtime.Serialization;
 using Xunit;
 
 namespace UnitTesting
-{
+{
+    /// <summary>
+    /// Classe de test de l'exception IndiceCodeException.
+    /// </summary>
     public class IndiceCodeExceptionUT
     {
+        /// <summary>
+        /// Test de l'exception IndiceCodeException par defaut.
+        /// </summary>
         [Fact]
         public void ExceptionDefaut()
         {
             Assert.ThrowsAsync<IndiceCodeException>(() => throw new IndiceCodeException());
         }
 
+        /// <summary>
+        /// Test des attributs de l'exception IndiceCodeException.
+        /// </summary>
         [Fact]
         public void ExceptionAttributs()
         {
@@ -29,6 +38,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test du message de l'exception IndiceCodeException.
+        /// </summary>
         [Fact]
         public void ExceptionMessage()
         {
@@ -46,6 +58,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test de l'exception IndiceCodeException et de ses messages.
+        /// </summary>
         [Fact]
         public void ExceptionMessageEtException()
         {
@@ -68,6 +83,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test de la serialisation de l'evenement IndiceCodeException.
+        /// </summary>
         [Fact]
         public void ExceptionSerialisation()
         {
diff --git a/Sources/UnitTesting/JoueurDejaPresentExceptionUT.cs b/Sources/UnitTesting/JoueurDejaPresentExceptionUT.cs
index d6b3975..2246eb5 100644
--- a/Sources/UnitTesting/JoueurDejaPresentExceptionUT.cs
+++ b/Sources/UnitTesting/JoueurDejaPresentExceptionUT.cs
@@ -4,15 +4,24 @@ using System.Runtime.Serialization;
 using Xunit;
 
 namespace UnitTesting
-{
+{
+    /// <summary>
+    /// Classe de test de l'exception JoueurDejaPresentException.
+    /// </summary>
     public class JoueurDejaPresentExceptionUT
     {
+        /// <summary>
+        /// Test de l'exception JoueurDejaPresentException par defaut.
+        /// </summary>
         [Fact]
         public void ExceptionDefaut()
         {
             Assert.ThrowsAsync<JoueurDejaPresentException>(() => throw new JoueurDejaPresentException());
         }
 
+        /// <summary>
+        /// Test du message de l'exception JoueurDejaPresentException.
+        /// </summary>
         [Fact]
         public void ExceptionMessage()
         {
@@ -30,6 +39,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test de l'exception JoueurDejaPresentException et ses messages.
+        /// </summary>
         [Fact]
         public void ExceptionMessageEtException()
         {
@@ -52,6 +64,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test de la serilisation de l'exception JoueurDejaPresentException.
+        /// </summary>
         [Fact]
         public void ExceptionSerialisation()
         {
diff --git a/Sources/UnitTesting/NomJoueurInterditExceptionUT.cs b/Sources/UnitTesting/NomJoueurInterditExceptionUT.cs
index 6659841..37469ad 100644
--- a/Sources/UnitTesting/NomJoueurInterditExceptionUT.cs
+++ b/Sources/UnitTesting/NomJoueurInterditExceptionUT.cs
@@ -4,15 +4,24 @@ using System.Runtime.Serialization;
 using Xunit;
 
 namespace UnitTesting
-{
+{
+    /// <summary>
+    /// Classe de test pour l'exception NomJoueurInterditException.
+    /// </summary>
     public class NomJoueurInterditExceptionUT
     {
+        /// <summary>
+        /// Test de l'exception NomJoueurInterditException par defaut.
+        /// </summary>
         [Fact]
         public void ExceptionDefaut()
         {
             Assert.ThrowsAsync<NomJoueurInterditException>(() => throw new NomJoueurInterditException());
         }
 
+        /// <summary>
+        /// Test du message de l'exception NomJoueurInterditException.
+        /// </summary>
         [Fact]
         public void ExceptionMessage()
         {
@@ -30,6 +39,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test de l'exception NomJoueurInterditException et de ses messages.
+        /// </summary>
         [Fact]
         public void ExceptionMessageEtException()
         {
@@ -52,6 +64,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test de la serilisation de l'exception NomJoueurInterditException.
+        /// </summary>
         [Fact]
         public void ExceptionSerialisation()
         {
diff --git a/Sources/UnitTesting/TailleCodeExceptionUT.cs b/Sources/UnitTesting/TailleCodeExceptionUT.cs
index 7c1bfbe..49db1b8 100644
--- a/Sources/UnitTesting/TailleCodeExceptionUT.cs
+++ b/Sources/UnitTesting/TailleCodeExceptionUT.cs
@@ -5,14 +5,23 @@ using Xunit;
 
 namespace UnitTesting
 {
+    /// <summary>
+    /// Classe de test de l'exception TailleCodeException.
+    /// </summary>
     public class TailleCodeExceptionUT
     {
+        /// <summary>
+        /// Test l'exception par defaut.
+        /// </summary>
         [Fact]
         public void ExceptionDefaut()
         {
             Assert.ThrowsAsync<TailleCodeException>(() => throw new TailleCodeException());
         }
 
+        /// <summary>
+        /// Test les attributs de l'exception.
+        /// </summary>
         [Fact]
         public void ExceptionAttributs()
         {
@@ -28,6 +37,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test le message de l'exception TailleCodeException.
+        /// </summary>
         [Fact]
         public void ExceptionMessage()
         {
@@ -45,6 +57,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test l'exception TailleCodeException et ses messages.
+        /// </summary>
         [Fact]
         public void ExceptionMessageEtException()
         {
@@ -67,6 +82,9 @@ namespace UnitTesting
             }
         }
 
+        /// <summary>
+        /// Test la serialisation de l'exception TailleCodeException.
+        /// </summary>
         [Fact]
         public void ExceptionSerialisation()
         {
diff --git a/Sources/UnitTesting/TailleGrilleExceptionUT.cs b/Sources/UnitTesting/TailleGrilleExceptionUT.cs
index 7d4bf33..83b77fa 100644
--- a/Sources/UnitTesting/TailleGrilleExceptionUT.cs
+++ b/Sources/UnitTesting/TailleGrilleExceptionUT.cs
@@ -5,14 +5,23 @@ using Xunit;
 
 namespace UnitTesting
 {
+    /// <summary>
+    /// Classe de test de l'exception TailleGrille.
+    /// </summary>
     public class TailleGrilleExceptionUT
-    {
+    {
+        /// <summary>
+        /// Test l'exception par defaut.
+        /// </summary>
         [Fact]
         public void ExceptionDefaut()
         {
             Assert.ThrowsAsync<TailleGrilleException>(() => throw new TailleGrilleException());
-        }
-
+        }
+
+        /// <summary>
+        /// Test l'exception avec ces attributs.
+        /// </summary>
         [Fact]
         public void ExceptionAttributs()
         {
@@ -26,8 +35,11 @@ namespace UnitTesting
             {
                 Assert.Contains("0", e.Message);
             }
-        }
-
+        }
+
+        /// <summary>
+        /// Test l'affichage du message de l'exception TailleGrilleException.
+        /// </summary>
         [Fact]
         public void ExceptionMessage()
         {
@@ -43,8 +55,11 @@ namespace UnitTesting
             {
                 Assert.Equal(message, e.Message);
             }
-        }
-
+        }
+
+        /// <summary>
+        /// Test l'exception TailleGrilleException et ses messages.
+        /// </summary>
         [Fact]
         public void ExceptionMessageEtException()
         {
@@ -65,8 +80,11 @@ namespace UnitTesting
                 Assert.IsType<InvalidOperationException>(e.InnerException);
                 Assert.Equal(message2, e.InnerException.Message);
             }
-        }
-
+        }
+
+        /// <summary>
+        /// Test la serialisation de l'exception TailleGrilleException.
+        /// </summary>
         [Fact]
         public void ExceptionSerialisation()
         {