Resolve WES-181 "Missing code doc"

Assets/Common/Interfaces/Course.cs

@@ -6,7 +6,6 @@ using UnityEngine;
 [CreateAssetMenu(menuName = "Create new Scriptable/Course")]
 public class Course : ScriptableObject
 {
-
     /// <summary>
     /// Index of the course
     /// </summary>

Assets/Common/Interfaces/MinigameList.cs

@@ -1,7 +1,6 @@
 using System.Collections.Generic;
 using UnityEngine;
 
-
 /// <summary>
 /// Keep track off installed minigames
 /// </summary>

Assets/Common/Interfaces/ModelList.cs

@@ -2,6 +2,7 @@ using NatML;
 using System;
 using System.Collections.Generic;
 using UnityEngine;
+
 /// <summary>
 /// This scriptable will hold tupples of Courseindices and models
 /// </summary>
@@ -33,7 +34,6 @@ public class ModelList : ScriptableObject
         public TextAsset embeddingsFile;
     }
 
-
     /// <summary>
     /// A list of all the models
     /// </summary>
@@ -61,7 +61,6 @@ public class ModelList : ScriptableObject
         return null;
     }
 
-
     /// <summary>
     /// Function to check if the modelIndex has been set
     /// </summary>
@@ -80,11 +79,19 @@ public class ModelList : ScriptableObject
         currentModelIndex = models.FindIndex((m) => m.index == index);
     }
 
+    /// <summary>
+    /// Shortcut for getting the index of the current model
+    /// </summary>
+    /// <returns></returns>
     public ModelIndex GetCurrentModelIndex()
     {
         return models[currentModelIndex].index;
     }
 
+    /// <summary>
+    /// Shortcut for getting the embeddings TextAsset of the current model
+    /// </summary>
+    /// <returns></returns>
     public TextAsset GetEmbeddings()
     {
         return models[currentModelIndex].embeddingsFile;

Assets/Common/Interfaces/Theme.cs

@@ -28,10 +28,8 @@ public class Theme : ScriptableObject
     /// </summary>
     public ModelIndex modelIndex;
 
-
     /// <summary>
     /// List of all learnable words/letters
     /// </summary>
     public List<Learnable> learnables = new List<Learnable>();
-
 }

Assets/Common/Interfaces/ThemeList.cs

@@ -1,7 +1,6 @@
 using System.Collections.Generic;
 using UnityEngine;
 
-
 /// <summary>
 /// Keep track off defined themes
 /// </summary>