Resolve WES-181 "Missing code doc"

Assets/JustSign/Scripts/JustSignController.cs

@@ -59,27 +59,27 @@ public class JustSignController : AbstractMinigameController
     /// <summary>
     /// Score obtained when getting a perfect hit
     /// </summary>
-    private int perfectScore = 50;
+    private const int perfectScore = 50;
 
     /// <summary>
     /// Score obtained when getting a good hit
     /// </summary>
-    private int goodScore = 20;
+    private const int goodScore = 20;
 
     /// <summary>
     /// Score obtained when getting a meh hit
     /// </summary>
-    private int mehScore = 10;
+    private const int mehScore = 10;
 
     /// <summary>
     /// Score obtained when getting a terrible hit
     /// </summary>
-    private int terribleScore = -3;
+    private const int terribleScore = -3;
 
     /// <summary>
     /// Score obtained when symbol goes offscreen
     /// </summary>
-    private int offscreenScore = -5;
+    private const int offscreenScore = -5;
 
     /// <summary>
     /// Symbol prefab
@@ -109,17 +109,17 @@ public class JustSignController : AbstractMinigameController
     /// <summary>
     /// Controls movement speed of symbols (higher -> faster)
     /// </summary>
-    private int moveSpeed = 100;
+    private const int moveSpeed = 100;
 
     /// <summary>
     /// Starting X-coordinate of a symbol = (-1920 - symbolsize) / 2
     /// </summary>
-    private int trackX = 1920 / 2;
+    private const int trackX = 1920 / 2;
 
     /// <summary>
     /// Starting Y-coordinate of a symbol
     /// </summary>
-    private int trackY = 0;
+    private const int trackY = 0;
 
     /// <summary>
     /// Time at which the last symbol was spawned
@@ -246,6 +246,9 @@ public class JustSignController : AbstractMinigameController
     /// </summary>
     public GameObject userFeedback;
 
+    /// <summary>
+    /// Get the current theme
+    /// </summary>
     protected override Theme signPredictorTheme
     {
         get { return currentTheme; }

Assets/JustSign/Scripts/JustSignGameEndedPanel.cs

@@ -1,9 +1,5 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
 using TMPro;
-using UnityEngine;
-using UnityEngine.UI;
+
 /// <summary>
 /// The JustSign-variant of the ScoreBoard
 /// </summary>

Assets/JustSign/Scripts/Song.cs

@@ -1,5 +1,4 @@
 using UnityEngine;
-using UnityEngine.Audio;
 
 /// <summary>
 /// Class for holding all (static) data about a certain song

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()
     {