From f84e7b4656f1e69cced4e58117df920efaec922e Mon Sep 17 00:00:00 2001
From: lat9nq <22451773+lat9nq@users.noreply.github.com>
Date: Sun, 23 Jul 2023 16:21:08 -0400
Subject: settings_common: Document specializations

---
 src/common/settings_common.h | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

(limited to 'src')

diff --git a/src/common/settings_common.h b/src/common/settings_common.h
index 6f90ae90d..2efb329b0 100644
--- a/src/common/settings_common.h
+++ b/src/common/settings_common.h
@@ -46,17 +46,18 @@ constexpr u8 SpecializationTypeMask = 0xf;
 constexpr u8 SpecializationAttributeMask = 0xf0;
 constexpr u8 SpecializationAttributeOffset = 4;
 
+// Scalar and countable could have better names
 enum Specialization : u8 {
     Default = 0,
-    Time = 1,
-    Hex = 2,
-    List = 3,
-    RuntimeList = 4,
-    Scalar = 5,
-    Countable = 6,
-    Paired = 7,
-
-    Percentage = (1 << SpecializationAttributeOffset),
+    Time = 1,        // Duration or specific moment in time
+    Hex = 2,         // Hexadecimal number
+    List = 3,        // Setting has specific members
+    RuntimeList = 4, // Members of the list are determined during runtime
+    Scalar = 5,      // Values are continuous
+    Countable = 6,   // Can be stepped through
+    Paired = 7,      // Another setting is associated with this setting
+
+    Percentage = (1 << SpecializationAttributeOffset), // Should be represented as a percentage
 };
 
 class BasicSetting;
-- 
cgit v1.2.3