From ac99a38175c78612d058b40e7e1219d440b3d7ce Mon Sep 17 00:00:00 2001
From: rubidium42 <rubidium@openttd.org>
Date: Sat, 22 May 2021 08:32:51 +0200
Subject: [PATCH] Cleanup: remove and/or fix some confusing comments

The comments for SettingDescType; it is a byte, so not 4 bytes and since it is not a flag there are about 250 other possibilities left instead of 9.
SettingGuiFlag is uint16 so has 2 bytes allocated.
SettingDescGlobVarList and related comments imply that global vars cannot be used elsewhere, but they are used for settings just fine. Even then the type is not used anywhere else but the definition of the table.
---
 src/settings_internal.h       | 17 +----------------
 src/table/misc_settings.ini   |  2 +-
 src/table/settings.h.preamble |  4 +---
 src/table/win32_settings.ini  |  2 +-
 4 files changed, 4 insertions(+), 21 deletions(-)

diff --git a/src/settings_internal.h b/src/settings_internal.h
index 225bb71953..fc8e0a1e30 100644
--- a/src/settings_internal.h
+++ b/src/settings_internal.h
@@ -19,22 +19,16 @@
  * @see SettingDescBase
  */
 enum SettingDescType : byte {
-	/* 4 bytes allocated a maximum of 16 types for GenericType */
-	SDT_BEGIN       = 0,
 	SDT_NUMX        = 0, ///< any number-type
 	SDT_BOOLX       = 1, ///< a boolean number
 	SDT_ONEOFMANY   = 2, ///< bitmasked number where only ONE bit may be set
 	SDT_MANYOFMANY  = 3, ///< bitmasked number where MULTIPLE bits may be set
 	SDT_INTLIST     = 4, ///< list of integers separated by a comma ','
 	SDT_STDSTRING   = 6, ///< \c std::string
-	SDT_END,
-	/* 9 more possible primitives */
 };
 
-
 enum SettingGuiFlag : uint16 {
-	/* 1 byte allocated for a maximum of 8 flags
-	 * Flags directing saving/loading of a variable */
+	/* 2 bytes allocated for a maximum of 16 flags. */
 	SGF_NONE = 0,
 	SGF_0ISDISABLED   = 1 << 0, ///< a value of zero means the feature is disabled
 	SGF_DISPLAY_ABS   = 1 << 1, ///< display absolute value of the setting
@@ -114,15 +108,6 @@ struct SettingDesc {
 	SettingType GetType() const;
 };
 
-/* NOTE: The only difference between SettingDesc and SettingDescGlob is
- * that one uses global variables as a source and the other offsets
- * in a struct which are bound to a certain variable during runtime.
- * The only way to differentiate between these two is to check if an object
- * has been passed to the function or not. If not, then it is a global variable
- * and save->variable has its address, otherwise save->variable only holds the
- * offset in a certain struct */
-typedef SettingDesc SettingDescGlobVarList;
-
 const SettingDesc *GetSettingFromName(const char *name);
 bool SetSettingValue(const SettingDesc *sd, int32 value, bool force_newgame = false);
 bool SetSettingValue(const SettingDesc *sd, const char *value, bool force_newgame = false);
diff --git a/src/table/misc_settings.ini b/src/table/misc_settings.ini
index 37994644a6..2613b4dddb 100644
--- a/src/table/misc_settings.ini
+++ b/src/table/misc_settings.ini
@@ -16,7 +16,7 @@ extern bool _allow_hidpi_window;
 #define WITHOUT_COCOA
 #endif
 
-static const SettingDescGlobVarList _misc_settings[] = {
+static const SettingDesc _misc_settings[] = {
 [post-amble]
 };
 [templates]
diff --git a/src/table/settings.h.preamble b/src/table/settings.h.preamble
index 826b272d7a..6410b0360f 100644
--- a/src/table/settings.h.preamble
+++ b/src/table/settings.h.preamble
@@ -23,9 +23,7 @@ static size_t ConvertLandscape(const char *value);
  * The macros can be grouped depending on where the config variable is
  * stored:
  * 1. SDTG_something
- *    These are for global variables, so this is the one you will use
- *    for a #SettingDescGlobVarList section. Here 'var' refers to a
- *    global variable.
+ *    These are for global variables. Here 'var' refers to a global variable.
  * 2. SDTC_something
  *    These are for client-only variables. Here the 'var' refers to an
  *    entry inside _settings_client.
diff --git a/src/table/win32_settings.ini b/src/table/win32_settings.ini
index c3cc45014c..963a11df8c 100644
--- a/src/table/win32_settings.ini
+++ b/src/table/win32_settings.ini
@@ -9,7 +9,7 @@
 #if defined(_WIN32) && !defined(DEDICATED)
 extern bool _window_maximize;
 
-static const SettingDescGlobVarList _win32_settings[] = {
+static const SettingDesc _win32_settings[] = {
 [post-amble]
 };
 #endif /* _WIN32 */