From 4e3e0c16c3f63e419d45138c330f368613fd2400 Mon Sep 17 00:00:00 2001
From: Mark Joshwel <mark@joshwel.co>
Date: Tue, 19 Nov 2024 14:38:40 +0800
Subject: [PATCH] game: better comments

---
 ColourMeOKGame/Assets/Scripts/Colorimetry.cs           | 3 +++
 ColourMeOKGame/Assets/Scripts/DemoOklchColourPicker.cs | 3 +++
 ColourMeOKGame/Assets/Scripts/LocalPlayerData.cs       | 3 +++
 ColourMeOKGame/Assets/Scripts/SideViewUI.cs            | 2 +-
 4 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/ColourMeOKGame/Assets/Scripts/Colorimetry.cs b/ColourMeOKGame/Assets/Scripts/Colorimetry.cs
index f6c585e..e006397 100644
--- a/ColourMeOKGame/Assets/Scripts/Colorimetry.cs
+++ b/ColourMeOKGame/Assets/Scripts/Colorimetry.cs
@@ -1,6 +1,9 @@
 using System;
 using UnityEngine;
 
+/// <summary>
+///     class for anything related to colour spaces and models
+/// </summary>
 public static class Colorimetry
 {
     /// <summary>
diff --git a/ColourMeOKGame/Assets/Scripts/DemoOklchColourPicker.cs b/ColourMeOKGame/Assets/Scripts/DemoOklchColourPicker.cs
index 186f336..f037611 100644
--- a/ColourMeOKGame/Assets/Scripts/DemoOklchColourPicker.cs
+++ b/ColourMeOKGame/Assets/Scripts/DemoOklchColourPicker.cs
@@ -1,5 +1,8 @@
 using UnityEngine.UIElements;
 
+/// <summary>
+///     class that inherits from OklchColourPickerUI for the demo colour picker on the DefaultView
+/// </summary>
 public class DemoOklchColourPicker : OklchColourPickerUI
 {
     /// <summary>
diff --git a/ColourMeOKGame/Assets/Scripts/LocalPlayerData.cs b/ColourMeOKGame/Assets/Scripts/LocalPlayerData.cs
index b1f3a52..f77d47b 100644
--- a/ColourMeOKGame/Assets/Scripts/LocalPlayerData.cs
+++ b/ColourMeOKGame/Assets/Scripts/LocalPlayerData.cs
@@ -4,6 +4,9 @@
 using System.Linq;
 using UnityEngine;
 
+/// <summary>
+///     local player data structure/class
+/// </summary>
 public class LocalPlayerData
 {
     /// <summary>
diff --git a/ColourMeOKGame/Assets/Scripts/SideViewUI.cs b/ColourMeOKGame/Assets/Scripts/SideViewUI.cs
index e3cc9b4..7d88455 100644
--- a/ColourMeOKGame/Assets/Scripts/SideViewUI.cs
+++ b/ColourMeOKGame/Assets/Scripts/SideViewUI.cs
@@ -2,7 +2,7 @@
 using UnityEngine.UIElements;
 
 /// <summary>
-///     singleton for a single source of truth game state and flow management
+///     class that handles the side view ui
 /// </summary>
 public class SideViewUI : MonoBehaviour
 {