summaryrefslogtreecommitdiff
path: root/src/table/settings.h.preamble
diff options
context:
space:
mode:
authorrubidium42 <rubidium@openttd.org>2021-05-22 08:32:51 +0200
committerrubidium42 <rubidium42@users.noreply.github.com>2021-05-27 18:49:43 +0200
commitac99a38175c78612d058b40e7e1219d440b3d7ce (patch)
treedefdad69d6aa48997a64bb72e7d6ffe44e898eb6 /src/table/settings.h.preamble
parent8ffb4122df903393bceca49a25ac81cc42cca3ff (diff)
downloadopenttd-ac99a38175c78612d058b40e7e1219d440b3d7ce.tar.xz
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.
Diffstat (limited to 'src/table/settings.h.preamble')
-rw-r--r--src/table/settings.h.preamble4
1 files changed, 1 insertions, 3 deletions
diff --git a/src/table/settings.h.preamble b/src/table/settings.h.preamble
index 826b272d7..6410b0360 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.