Resolve WES-181 "Missing code doc"

Assets/SpellingBee/Scripts/SpellingBeeController.cs

@@ -2,17 +2,18 @@ using DigitalRuby.Tween;
 using System;
 using System.Collections;
 using System.Collections.Generic;
-using System.Linq;
 using TMPro;
 using UnityEngine;
 using UnityEngine.UI;
 
+/// <summary>
+/// Contains all game logic for the SpellingBee game
+/// </summary>
 public partial class SpellingBeeController : AbstractMinigameController
 {
     /// <summary>
     /// All of the words that can be used in this session
     /// </summary>
-    //private string[] words;
     private List<Learnable> words = new List<Learnable>();
 
     /// <summary>
@@ -154,12 +155,12 @@ public partial class SpellingBeeController : AbstractMinigameController
     /// <summary>
     /// Score obtained when spelling a letter
     /// </summary>
-    private int correctLettersScore = 10;
+    private const int correctLettersScore = 10;
 
     /// <summary>
     /// Score obtained when spelling the wrong letter :o
     /// </summary>
-    private int incorrectLettersScore = -5;
+    private const int incorrectLettersScore = -5;
 
     /// <summary>
     /// Set the AbstractMinigameController variable to inform it of the theme for the signPredictor
@@ -198,7 +199,6 @@ public partial class SpellingBeeController : AbstractMinigameController
             int seconds = Mathf.FloorToInt(timerValue % 60.0f);
 
             timerText.text = string.Format("{0:00}:{1:00}", minutes, seconds);
-
         }
     }
 
@@ -310,7 +310,6 @@ public partial class SpellingBeeController : AbstractMinigameController
         }
         else
         {
-            //ActivateWin();
             ActivateEnd(true);
         }
     }
@@ -338,9 +337,8 @@ public partial class SpellingBeeController : AbstractMinigameController
     }
 
     /// <summary>
-    /// wait for 2 seconds
+    /// Wait for 2 seconds
     /// </summary>
-    /// <returns></returns>
     private IEnumerator Wait()
     {
         yield return new WaitForSecondsRealtime(2);
@@ -458,7 +456,6 @@ public partial class SpellingBeeController : AbstractMinigameController
                 predictedSign = null;
                 previousIncorrectSign = null;
             }
-
             // Incorrect sign, wait a bit before passing it along
             else
             {
@@ -475,7 +472,6 @@ public partial class SpellingBeeController : AbstractMinigameController
                     previousIncorrectSign = null;
                 }
             }
-
         }
     }
 
@@ -527,7 +523,6 @@ public partial class SpellingBeeController : AbstractMinigameController
         bonusTimeText.SetActive(false);
 
         currentTheme = minigame.themeList.themes[minigame.themeList.currentThemeIndex];
-        //feedback.signPredictor.SetModel(currentTheme.modelIndex);
         words.AddRange(currentTheme.learnables);
         ShuffleWords();
         NextWord();

Assets/SpellingBee/Scripts/SpellingBeeGameEndedPanel.cs

@@ -1,10 +1,9 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
 using TMPro;
-using UnityEngine;
-using UnityEngine.UI;
 
+/// <summary>
+/// The SpellingBee-variant of the ScoreBoard
+/// </summary>
 public class SpellingBeeGameEndedPanel : AbstractGameEndedPanel
 {
     /// <summary>
@@ -29,6 +28,10 @@ public class SpellingBeeGameEndedPanel : AbstractGameEndedPanel
     /// Letters ( right | wrong )
     /// </summary>
     public TMP_Text lettersRightText;
+
+    /// <summary>
+    /// Letters ( right | wrong )
+    /// </summary>
     public TMP_Text lettersWrongText;
 
     /// <summary>