Resolve WES-181 "Missing code doc"

Assets/JustSign/Tests/PlayMode/JustSignControllerTests.cs

@@ -5,12 +5,14 @@ using UnityEditor;
 using UnityEngine;
 using UnityEngine.TestTools;
 
+/// <summary>
+/// Test the JustSignController class
+/// </summary>
 public class JustSignControllerTests
 {
     /// <summary>
     /// Setup for testing Just Sign
     /// </summary>
-    /// <returns></returns>
     [UnitySetUp]
     public IEnumerator SetupFunction()
     {
@@ -40,14 +42,13 @@ public class JustSignControllerTests
     /// <summary>
     /// Tests a sign that is done too quickly, i.e., feedback during game and scoreboard after
     /// </summary>
-    /// <returns></returns>
     [UnityTest]
     public IEnumerator EarlyScoreTest()
     {
         JustSignController justSignController = GameObject.FindObjectOfType<JustSignController>();
-        
+
         yield return new WaitForSeconds(5.0f);
-        
+
         string currentSign = justSignController.GetFirstSign();
         justSignController.ProcessMostProbableSign(1.0f, currentSign);
 
@@ -75,7 +76,6 @@ public class JustSignControllerTests
     /// <summary>
     /// Tests a sign that is done too late, i.e., feedback during game and scoreboard after
     /// </summary>
-    /// <returns></returns>
     [UnityTest]
     public IEnumerator TooLateScoreTest()
     {
@@ -105,7 +105,6 @@ public class JustSignControllerTests
     /// <summary>
     /// Tests a sign that is done in the meh-zone, i.e., feedback during game and scoreboard after
     /// </summary>
-    /// <returns></returns>
     [UnityTest]
     public IEnumerator MehScoreTest()
     {
@@ -140,7 +139,6 @@ public class JustSignControllerTests
     /// <summary>
     /// Tests a sign that is done in the good-zone, i.e., feedback during game and scoreboard after
     /// </summary>
-    /// <returns></returns>
     [UnityTest]
     public IEnumerator GoodScoreTest()
     {
@@ -175,7 +173,6 @@ public class JustSignControllerTests
     /// <summary>
     /// Tests a sign that is done in the perfect-zone, i.e., feedback during game and scoreboard after
     /// </summary>
-    /// <returns></returns>
     [UnityTest]
     public IEnumerator PerfectScoreTest()
     {
@@ -210,7 +207,6 @@ public class JustSignControllerTests
     /// <summary>
     /// Tests the entire game, i.e., feedback during game and scoreboard after
     /// </summary>
-    /// <returns></returns>
     [UnityTest]
     public IEnumerator WalkthroughTest()
     {
@@ -227,14 +223,14 @@ public class JustSignControllerTests
 
         currentSign = justSignController.GetFirstSign();
         justSignController.ProcessMostProbableSign(1.0f, currentSign);
-        
+
         Assert.AreEqual(justSignController.CalculateScore(), 7);
 
         yield return new WaitForSeconds(6.0f);
 
         currentSign = justSignController.GetFirstSign();
         justSignController.ProcessMostProbableSign(1.0f, currentSign);
-        
+
         Assert.AreEqual(justSignController.CalculateScore(), 27);
 
         yield return new WaitForSeconds(6.0f);
@@ -243,7 +239,7 @@ public class JustSignControllerTests
         justSignController.ProcessMostProbableSign(1.0f, currentSign);
 
         Assert.AreEqual(justSignController.CalculateScore(), 77);
-        
+
         yield return new WaitForSeconds(10.0f);
 
         Assert.AreEqual(justSignController.CalculateScore(), 72);
@@ -259,14 +255,13 @@ public class JustSignControllerTests
         Assert.AreEqual("1", justSignGameEndedPanel.terribleSignsText.text);
         Assert.AreEqual("1", justSignGameEndedPanel.notFoundSignsText.text);
         Assert.AreEqual("Score: 72", justSignGameEndedPanel.scoreText.text);
-        string gpmText = (60f * 4/ 64).ToString("#") + " GPM";
+        string gpmText = (60f * 4 / 64).ToString("#") + " GPM";
         Assert.AreEqual(gpmText, justSignGameEndedPanel.gpmText.text);
     }
 
     /// <summary>
     /// Tests if the game ends when the song does
     /// </summary>
-    /// <returns></returns>
     [UnityTest]
     public IEnumerator SongEndTest()
     {
@@ -294,7 +289,6 @@ public class JustSignControllerTests
     /// <summary>
     /// Tests the feedback in the game
     /// </summary>
-    /// <returns></returns>
     [UnityTest]
     public IEnumerator FeedbackTest()
     {