Add formatting rules

Assets/Common/Scripts/CourseScreenManager.cs

@@ -3,26 +3,44 @@ using System.Collections.Generic;
 using UnityEngine;
 using UnityEngine.SceneManagement;
 
+/// <summary>
+/// CourseScreen scene manager
+/// </summary>
 public class CourseScreenManager : MonoBehaviour
 {
-    [Header("Course Screen Components")]
-    // Reference to text that displays when there are no recent courses
+    /// <summary>
+    /// Reference to text that displays when there are no recent courses
+    /// </summary>
     public GameObject noRecentCourses;
-    // Reference to recent-courses-list holder object
+
+    /// <summary>
+    /// Reference to recent-courses-list container object
+    /// </summary>
     public Transform recentCoursesContainer;
-    // Reference to recommended-courses-list holder object
+
+    /// <summary>
+    /// Reference to recommended-courses-list container object
+    /// </summary>
     public Transform recommendedCoursesContainer;
 
-    [Header("Prefabs")]
-    // CourseItem prefab
+    /// <summary>
+    /// Prefab of the course item object
+    /// </summary>
     public GameObject courseItem;
 
-    [Header("User")]
-    // Reference to the users so we can get the current user;
+    /// <summary>
+    /// Reference to the users so we can get the current user;
+    /// </summary>
     public UserList userList;
-    // Reference to the courses
+
+    /// <summary>
+    /// Reference to the courses
+    /// </summary>
     public CourseList courseList;
 
+    /// <summary>
+    /// Start is called before the first frame update
+    /// </summary>
     void Start()
     {
         User user = userList.GetCurrentUser();
@@ -55,7 +73,10 @@ public class CourseScreenManager : MonoBehaviour
         }
     }
 
-    // Method used as callback for on click events
+    /// <summary>
+    /// Method used as callback for course item onClick events
+    /// </summary>
+    /// <param name="sceneName">The path to the new scene (<c>path == $"Assets/{sceneName}"</c>)</param>
     public void LoadScene(string sceneName)
     {
         SceneManager.LoadScene(sceneName);