Add formatting rules

Assets/Accounts/Scripts/Progress.cs

@@ -4,15 +4,26 @@ using System.IO;
 using System.Runtime.Serialization.Formatters.Binary;
 using UnityEngine;
 
+/// <summary>
+/// A class for holding all progress belonging to a user
+/// </summary>
 [Serializable]
-// Can not be created from Editor
 public class Progress
 {
+    /// <summary>
+    /// A helper class for handling the stored progress
+    /// </summary>
     [Serializable]
-    // Helper class to serialize into byte[]
     protected class DataEntry
     {
+        /// <summary>
+        /// The key, used to reference the data object
+        /// </summary>
         public string key;
+
+        /// <summary>
+        /// The object, representated as a list of byte (which can be serialized)
+        /// </summary>
         public List<byte> bytes = new List<byte>();
 
         public DataEntry(string key, byte[] data)
@@ -22,13 +33,21 @@ public class Progress
         }
     }
 
-    [Header("Course or Minigame")]
+    /// <summary>
+    /// Entries in the <c>Progress</c> object
+    /// </summary>
     [SerializeField]
-    // values belonging to a certain key, in List (which can be serialized)
     private List<DataEntry> entries = new List<DataEntry>();
 
 
-    // Add new `key` := `value`, returns `true` if successful
+    /// <summary>
+    /// Update the value of a certain key,
+    /// or add a new value if the key was not present
+    /// </summary>
+    /// <typeparam name="T">The type of the data to be added/updated</typeparam>
+    /// <param name="key">The key, used for referencing the data</param>
+    /// <param name="data">The object of type <typeparamref name="T"/></param>
+    /// <returns><c>true</c> if successful, <c>false</c> otherwise</returns>
     public bool AddOrUpdate<T>(string key, T data)
     {
         if (data == null)
@@ -55,6 +74,13 @@ public class Progress
     }
 
     // Get the value of type `T` belonging to `key`
+    /// <summary>
+    /// Get the data object of a certain key
+    /// </summary>
+    /// <typeparam name="T">The type of the data object</typeparam>
+    /// <param name="key">The key referencing the data object</param>
+    /// <returns>The data, cast to a type <typeparamref name="T"/></returns>
+    /// <exception cref="KeyNotFoundException"></exception>
     public T Get<T>(string key)
     {
         BinaryFormatter bf = new BinaryFormatter();