game: better comments

This commit is contained in:
Mark Joshwel 2024-11-19 14:38:40 +08:00
parent 41d5629bf3
commit 4e3e0c16c3
4 changed files with 10 additions and 1 deletions

View file

@ -1,6 +1,9 @@
using System; using System;
using UnityEngine; using UnityEngine;
/// <summary>
/// class for anything related to colour spaces and models
/// </summary>
public static class Colorimetry public static class Colorimetry
{ {
/// <summary> /// <summary>

View file

@ -1,5 +1,8 @@
using UnityEngine.UIElements; using UnityEngine.UIElements;
/// <summary>
/// class that inherits from OklchColourPickerUI for the demo colour picker on the DefaultView
/// </summary>
public class DemoOklchColourPicker : OklchColourPickerUI public class DemoOklchColourPicker : OklchColourPickerUI
{ {
/// <summary> /// <summary>

View file

@ -4,6 +4,9 @@
using System.Linq; using System.Linq;
using UnityEngine; using UnityEngine;
/// <summary>
/// local player data structure/class
/// </summary>
public class LocalPlayerData public class LocalPlayerData
{ {
/// <summary> /// <summary>

View file

@ -2,7 +2,7 @@
using UnityEngine.UIElements; using UnityEngine.UIElements;
/// <summary> /// <summary>
/// singleton for a single source of truth game state and flow management /// class that handles the side view ui
/// </summary> /// </summary>
public class SideViewUI : MonoBehaviour public class SideViewUI : MonoBehaviour
{ {