From 1a2f82bdb92204411f2d0f3c4d080f57a98420b8 Mon Sep 17 00:00:00 2001
From: Jordan Brown <Cyberboss@users.noreply.github.com>
Date: Thu, 5 Jul 2018 19:22:27 -0400
Subject: [PATCH 1/2] Adds comments to _globals.dm (#38893)

"Help" "understanding"
---
 code/__DEFINES/_globals.dm | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/code/__DEFINES/_globals.dm b/code/__DEFINES/_globals.dm
index 7e7aa3158f..e5f5929a95 100644
--- a/code/__DEFINES/_globals.dm
+++ b/code/__DEFINES/_globals.dm
@@ -1,11 +1,15 @@
-//See controllers/globals.dm
+//See also controllers/globals.dm
+
+//Creates a global initializer with a given InitValue expression, do not use
 #define GLOBAL_MANAGED(X, InitValue)\
 /datum/controller/global_vars/proc/InitGlobal##X(){\
     ##X = ##InitValue;\
     gvars_datum_init_order += #X;\
 }
+//Creates an empty global initializer, do not use
 #define GLOBAL_UNMANAGED(X) /datum/controller/global_vars/proc/InitGlobal##X() { return; }
 
+//Prevents a given global from being VV'd
 #ifndef TESTING
 #define GLOBAL_PROTECT(X)\
 /datum/controller/global_vars/InitGlobal##X(){\
@@ -16,23 +20,35 @@
 #define GLOBAL_PROTECT(X)
 #endif
 
+//Standard BYOND global, do not use
 #define GLOBAL_REAL_VAR(X) var/global/##X
+
+//Standard typed BYOND global, do not use
 #define GLOBAL_REAL(X, Typepath) var/global##Typepath/##X
 
+//Defines a global var on the controller, do not use
 #define GLOBAL_RAW(X) /datum/controller/global_vars/var/global##X
 
+//Create an untyped global with an initializer expression
 #define GLOBAL_VAR_INIT(X, InitValue) GLOBAL_RAW(/##X); GLOBAL_MANAGED(X, InitValue)
 
+//Create a global const var, do not use
 #define GLOBAL_VAR_CONST(X, InitValue) GLOBAL_RAW(/const/##X) = InitValue; GLOBAL_UNMANAGED(X)
 
+//Create a list global with an initializer expression
 #define GLOBAL_LIST_INIT(X, InitValue) GLOBAL_RAW(/list/##X); GLOBAL_MANAGED(X, InitValue)
 
+//Create a list global that is initialized as an empty list
 #define GLOBAL_LIST_EMPTY(X) GLOBAL_LIST_INIT(X, list())
 
+//Create a typed global with an initializer expression
 #define GLOBAL_DATUM_INIT(X, Typepath, InitValue) GLOBAL_RAW(Typepath/##X); GLOBAL_MANAGED(X, InitValue)
 
+//Create an untyped null global
 #define GLOBAL_VAR(X) GLOBAL_RAW(/##X); GLOBAL_UNMANAGED(X)
 
+//Create a null global list
 #define GLOBAL_LIST(X) GLOBAL_RAW(/list/##X); GLOBAL_UNMANAGED(X)
 
+//Create an typed null global
 #define GLOBAL_DATUM(X, Typepath) GLOBAL_RAW(Typepath/##X); GLOBAL_UNMANAGED(X)