Add formatting rules

Assets/Accounts/Tests/TestProgress.cs

@@ -3,24 +3,34 @@ using System.Collections.Generic;
 using System.Runtime.Serialization;
 using UnityEngine;
 
+/// <summary>
+/// Test the Progress class
+/// </summary>
 public class TestProgress : MonoBehaviour
 {
+    /// <summary>
+    /// A dummy serializable struct to perform test operations on
+    /// </summary>
     [Serializable]
-    // Dummy struct
     private struct SerializableStruct
     {
         public int r, g, b;
         public float x, y, z;
     }
 
+    /// <summary>
+    /// A dummy non-serializable struct to perform test operations on
+    /// </summary>
     private struct NonSerializableStruct
     {
         public int r, g, b;
         public float x, y, z;
     }
 
-
-    // Helper method, returns true if `Progress.Get(...)` throws a `KeyNotFoundException`
+    /// <summary>
+    /// Helper method
+    /// </summary>
+    /// <returns><c>true</c> if <c>Progress.AddOrUpdate(...)</c> throws a <c>SerializationException</c></returns>
     private bool AddNonSerializableStruct()
     {
         Progress progress = new Progress();
@@ -30,7 +40,10 @@ public class TestProgress : MonoBehaviour
         return false;
     }
 
-    // Helper method, returns true if `Progress.Get(...)` throws a `KeyNotFoundException`
+    /// <summary>
+    /// Helper method
+    /// </summary>
+    /// <returns><c>true</c> if <c>Progress.Get(...)</c> throws a <c>KeyNotFoundException</c></returns>
     private bool AccessInvalidKey()
     {
         Progress progress = new Progress();
@@ -39,7 +52,10 @@ public class TestProgress : MonoBehaviour
         return false;
     }
 
-    // Helper method, returns true if `Progress.Get(...)` throws a `InvalidCastException`
+    /// <summary>
+    /// Helper method
+    /// </summary>
+    /// <returns><c>true</c> if <c>Progress.Get(...)</c> throws a <c>InvalidCastException</c></returns>
     private bool AccessInvalidType()
     {
         Progress progress = new Progress();
@@ -49,6 +65,9 @@ public class TestProgress : MonoBehaviour
         return false;
     }
 
+    /// <summary>
+    /// Start is called before the first frame update
+    /// </summary>
     void Start()
     {
         TestNewProgress();
@@ -68,18 +87,27 @@ public class TestProgress : MonoBehaviour
         TestProgressGetStruct();
     }
 
+    /// <summary>
+    /// Test for creation of a new progress
+    /// </summary>
     public void TestNewProgress()
     {
         Progress progress = new Progress();
         Debug.Assert(progress != null);
     }
 
+    /// <summary>
+    /// Test whether invalid data will not be added
+    /// </summary>
     public void TestProgressAddInvalidData()
     {
         Progress progress = new Progress();
         Debug.Assert(!progress.AddOrUpdate<GameObject>("key", null));
     }
 
+    /// <summary>
+    /// Test whether a duplicated key will be added
+    /// </summary>
     public void TestProgressAddDuplicateKey()
     {
         Progress progress = new Progress();
@@ -87,45 +115,69 @@ public class TestProgress : MonoBehaviour
         Debug.Assert(progress.AddOrUpdate<int>("key 1", 1));
     }
 
+    /// <summary>
+    /// Test whether a <c>int</c> value can be added
+    /// </summary>
     public void TestProgressAddInt()
     {
         Progress progress = new Progress();
         Debug.Assert(progress.AddOrUpdate<int>("key", 1));
     }
 
+    /// <summary>
+    /// Test whether a <c>double</c> value can be added
+    /// </summary>
     public void TestProgressAddDouble()
     {
         Progress progress = new Progress();
         Debug.Assert(progress.AddOrUpdate<double>("key", 1.0));
     }
 
+    /// <summary>
+    /// Test whether a <c>string</c> value can be added
+    /// </summary>
     public void TestProgressAddString()
     {
         Progress progress = new Progress();
         Debug.Assert(progress.AddOrUpdate<string>("key", "Hello World!"));
     }
 
+    /// <summary>
+    /// Test whether a serializable struct can be added
+    /// </summary>
     public void TestProgressAddSerializableStruct()
     {
         Progress progress = new Progress();
         Debug.Assert(progress.AddOrUpdate<SerializableStruct>("key", new SerializableStruct()));
     }
 
+    /// <summary>
+    /// Test whether a non-serializable struct will throw an error
+    /// </summary>
     public void TestProgressAddNonSerializableStruct()
     {
         Debug.Assert(AddNonSerializableStruct());
     }
 
+    /// <summary>
+    /// Test whether an invalid key will throw an error
+    /// </summary>
     public void TestProgressGetInvalidKey()
     {
         Debug.Assert(AccessInvalidKey());
     }
 
+    /// <summary>
+    /// Test whether an invalid type will throw an error
+    /// </summary>
     public void TestProgressGetInvalidType()
     {
         Debug.Assert(AccessInvalidType());
     }
 
+    /// <summary>
+    /// Test whether a value is correctly updated
+    /// </summary>
     public void TestProgressUpdate()
     {
         Progress progress = new Progress();
@@ -135,6 +187,9 @@ public class TestProgress : MonoBehaviour
         Debug.Assert(progress.Get<int>("key") == 2);
     }
 
+    /// <summary>
+    /// Test whether a <c>int</c> value can be read
+    /// </summary>
     public void TestProgressGetInt()
     {
         Progress progress = new Progress();
@@ -142,6 +197,9 @@ public class TestProgress : MonoBehaviour
         Debug.Assert(progress.Get<int>("key") == 1);
     }
 
+    /// <summary>
+    /// Test whether a <c>double</c> value can be read
+    /// </summary>
     public void TestProgressGetDouble()
     {
         Progress progress = new Progress();
@@ -149,6 +207,9 @@ public class TestProgress : MonoBehaviour
         Debug.Assert(progress.Get<double>("key") == 1.0);
     }
 
+    /// <summary>
+    /// Test whether a <c>string</c> value can be read
+    /// </summary>
     public void TestProgressGetString()
     {
         Progress progress = new Progress();
@@ -156,6 +217,9 @@ public class TestProgress : MonoBehaviour
         Debug.Assert(progress.Get<string>("key") == "Hello World!");
     }
 
+    /// <summary>
+    /// Test whether a serializable struct can be read
+    /// </summary>
     public void TestProgressGetStruct()
     {
         Progress progress = new Progress();