Add formatting rules

Assets/Courses/Scripts/Course.cs

@@ -3,32 +3,56 @@ using System.Collections.Generic;
 using UnityEngine;
 using UnityEngine.Video;
 
+/// <summary>
+/// Class for holding all (static) data about a certain course
+/// </summary>
 [CreateAssetMenu(menuName = "Create new Scriptable/Course")]
 public class Course : ScriptableObject
 {
+    /// <summary>
+    /// Small class to hold information about a single learnable (e.g., a word or a letter)
+    /// </summary>
     [Serializable]
-    // Small class to hold information about a single learnable (e.g., a word or a letter)
     public class Learnable
     {
-        // Name of the word/letter to learn
+        /// <summary>
+        /// Name of the word/letter to learn
+        /// </summary>
         public string name;
-        // Sprite of this word/letter
+
+        /// <summary>
+        /// Sprite of this word/letter
+        /// </summary>
         public Sprite image;
-        // Example video clip
+
+        /// <summary>
+        /// Example video clip
+        /// </summary>
         public VideoClip clip;
     }
 
-    [Header("Course info")]
-    // Course index
+    /// <summary>
+    /// Index of the course
+    /// </summary>
     public CourseIndex index;
-    // Course title
+
+    /// <summary>
+    /// The course title
+    /// </summary>
     public string title;
-    // Short desciption of the course
+
+    /// <summary>
+    /// A short description of the course
+    /// </summary>
     public string description;
-    // Thumbnail of the course
+
+    /// <summary>
+    /// Reference to the course thumbnail
+    /// </summary>
     public Sprite thumbnail;
 
-    [Header("Learnable words")]
-    // List of learnable words/letters
+    /// <summary>
+    /// List of all learnable words/letters
+    /// </summary>
     public List<Learnable> learnables = new List<Learnable>();
 }