Resolve WES-181 "Missing code doc"

Assets/Accounts/Tests/EditMode/UserListTests.cs

@@ -26,8 +26,6 @@ public class UserListTests
     /// </summary>
     private Sprite avatar = null;
 
-    private string cachedPath;
-
     /// <summary>
     /// Setup the tests
     /// </summary>
@@ -98,8 +96,6 @@ public class UserListTests
         Assert.IsNull(user);
     }
 
-
-
     /// <summary>
     /// Test whether an existing user can be found by its username
     /// </summary>

Assets/Accounts/Tests/EditMode/UserTests.cs

@@ -25,7 +25,6 @@ public class UserTests
         user = new User(data);
     }
 
-
     /// <summary>
     /// Test for the creation of a new user
     /// </summary>

Assets/Accounts/Tests/PlayMode/PanelCourseProgressTests.cs

@@ -110,6 +110,9 @@ public class PanelCourseProgressTests
         Assert.IsNotNull(panel.progressBar);
     }
 
+    /// <summary>
+    /// Test whether the panel is correctly initialized
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_Start()
     {
@@ -126,6 +129,9 @@ public class PanelCourseProgressTests
         Assert.AreEqual(course.theme.learnables.Count, panel.learnablesContainer.childCount);
     }
 
+    /// <summary>
+    /// Test whether the panel is correctly initialized when there is no course progress
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_Start_Empty()
     {

Assets/Accounts/Tests/PlayMode/PanelMinigamesProgressTests.cs

@@ -109,7 +109,6 @@ public class PanelMinigameProgressTests
         PersistentDataController.PATH = null;
     }
 
-
     /// <summary>
     /// Test whether every item that needs to be assign in the editor, is assigned
     /// </summary>
@@ -130,6 +129,9 @@ public class PanelMinigameProgressTests
         Assert.IsNotNull(panel.emptyHighscore);
     }
 
+    /// <summary>
+    /// Test whether the panel is correctly initialized
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_Start()
     {
@@ -145,6 +147,9 @@ public class PanelMinigameProgressTests
         Assert.AreEqual(minigame.title, panel.minigameTitle.text);
     }
 
+    /// <summary>
+    /// Test whether the panel is correctly initialized when there is no minigame progress
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_Start_Empty()
     {
@@ -155,6 +160,9 @@ public class PanelMinigameProgressTests
         Assert.IsTrue(panel.emptyMinigames.gameObject.activeSelf);
     }
 
+    /// <summary>
+    /// Test whether the panel is correctly initialized when there are minigames, but these don't have any score
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_Start_NoScorePresent()
     {

Assets/Accounts/Tests/PlayMode/ProgressGraphTests.cs

@@ -62,6 +62,9 @@ public class ProgressGraphTests
         Assert.IsNotNull(graph.axesTickMarker);
     }
 
+    /// <summary>
+    /// Test whether negative values are correctly plotted
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_PlotGraph_Negative()
     {
@@ -70,6 +73,9 @@ public class ProgressGraphTests
         Assert.IsTrue(true);
     }
 
+    /// <summary>
+    /// Test whether values between 0 and 1 are correctly plotted
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_PlotGraph_SmallerThen1()
     {
@@ -78,6 +84,9 @@ public class ProgressGraphTests
         Assert.IsTrue(true);
     }
 
+    /// <summary>
+    /// Test whether values around 0 are correctly plotted
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_PlotGraph_AroundZero()
     {
@@ -86,6 +95,9 @@ public class ProgressGraphTests
         Assert.IsTrue(true);
     }
 
+    /// <summary>
+    /// Test whether all 0 values are correctly plotted
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_PlotGraph_AllZeros()
     {
@@ -94,6 +106,9 @@ public class ProgressGraphTests
         Assert.IsTrue(true);
     }
 
+    /// <summary>
+    /// Test whether values between -1 and 1 are correctly plotted
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_PlotGraph_BetweenPos1AndNeg1()
     {
@@ -102,6 +117,9 @@ public class ProgressGraphTests
         Assert.IsTrue(true);
     }
 
+    /// <summary>
+    /// Test whether a single value is correctly plotted
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_PlotGraph_Single()
     {
@@ -110,6 +128,9 @@ public class ProgressGraphTests
         Assert.IsTrue(true);
     }
 
+    /// <summary>
+    /// Test whether multiple values are correctly plotted
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_PlotGraph_Multiple()
     {
@@ -118,6 +139,9 @@ public class ProgressGraphTests
         Assert.IsTrue(true);
     }
 
+    /// <summary>
+    /// Test whether too many values (capped at 10) are correctly plotted
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_PlotGraph_TooMany()
     {

Assets/Accounts/Tests/PlayMode/UserCreationScreenTests.cs

@@ -44,6 +44,7 @@ public class UserCreationScreenTests
     {
         PersistentDataController.PATH = null;
     }
+
     /// <summary>
     /// Test whether every item that needs to be assign in the editor, is assigned
     /// </summary>

Assets/Accounts/Tests/PlayMode/UserProgressScreenTests.cs

@@ -102,6 +102,9 @@ public class UserProgressScreenTests
         Assert.IsFalse(userProgressController.minigamesPanel.activeSelf);
     }
 
+    /// <summary>
+    /// Test whether the course panel is displayed
+    /// </summary>
     [UnityTest]
     public IEnumerator Test_DisplayCourses()
     {
@@ -115,6 +118,10 @@ public class UserProgressScreenTests
         Assert.IsFalse(userProgressController.minigamesPanel.activeSelf);
     }
 
+    /// <summary>
+    /// Test whether the minigames panel is displayed
+    /// </summary>
+    /// <returns></returns>
     [UnityTest]
     public IEnumerator Test_DisplayMinigames()
     {