From f623126fe1ad170ef30337fb4d1b157bc0506262 Mon Sep 17 00:00:00 2001
From: voed <iwmyc@ex.ua>
Date: Mon, 11 Feb 2019 13:15:45 +0200
Subject: [PATCH] Improve documentation in engine_const.inc (#665)

---
 plugins/include/engine_const.inc | 91 ++++++++++++++++++--------------
 1 file changed, 51 insertions(+), 40 deletions(-)

diff --git a/plugins/include/engine_const.inc b/plugins/include/engine_const.inc
index c48bbda2..389a7766 100755
--- a/plugins/include/engine_const.inc
+++ b/plugins/include/engine_const.inc
@@ -12,7 +12,7 @@
 //
 
 #if defined _engine_const_included
-  #endinput
+	#endinput
 #endif
 #define _engine_const_included
 
@@ -212,54 +212,63 @@ enum {
  */
 
 #if defined _jghg_enums
-  #endinput
+	#endinput
 #endif
 #define _jghg_enums
+
+/**
+ * Used by get_global_[edict/float/int/string/vector]()
+ */
 enum {
-    // Edict
-    GL_trace_ent = 0,
 
-    // Float
-    GL_coop,
-    GL_deathmatch,
-    GL_force_retouch,
-    GL_found_secrets,
-    GL_frametime,
-    GL_serverflags,
-    GL_teamplay,
-    GL_time,
-    GL_trace_allsolid,
-    GL_trace_fraction,
-    GL_trace_inopen,
-    GL_trace_inwater,
-    GL_trace_plane_dist,
-    GL_trace_startsolid,
+	// Edict
+	GL_trace_ent = 0,
 
-    // Int
-    GL_cdAudioTrack,
-    GL_maxClients,
-    GL_maxEntities,
-    GL_msg_entity,
-    GL_trace_flags,
-    GL_trace_hitgroup,
+	// Float
+	GL_coop,
+	GL_deathmatch,
+	GL_force_retouch,
+	GL_found_secrets,
+	GL_frametime,
+	GL_serverflags,
+	GL_teamplay,
+	GL_time,
+	GL_trace_allsolid,
+	GL_trace_fraction,
+	GL_trace_inopen,
+	GL_trace_inwater,
+	GL_trace_plane_dist,
+	GL_trace_startsolid,
 
-    // String
-    GL_pStringBase,
-    GL_mapname,
-    GL_startspot,
+	// Int
+	GL_cdAudioTrack,
+	GL_maxClients,
+	GL_maxEntities,
+	GL_msg_entity,
+	GL_trace_flags,
+	GL_trace_hitgroup,
 
-    // Vector
-    GL_trace_endpos,
-    GL_trace_plane_normal,
-    GL_v_forward,
-    GL_v_right,
-    GL_v_up,
-    GL_vecLandmarkOffset,
+	// String
+	GL_pStringBase,
+	GL_mapname,
+	GL_startspot,
 
-    // Void (not supported)
-    GL_pSaveData
+	// Vector
+	GL_trace_endpos,
+	GL_trace_plane_normal,
+	GL_v_forward,
+	GL_v_right,
+	GL_v_up,
+	GL_vecLandmarkOffset,
+
+	// Void (not supported)
+	GL_pSaveData
 };
 
+
+/**
+ * Used by [get/set]_usercmd()
+ */
 enum
 {
 	usercmd_float_start,
@@ -282,7 +291,9 @@ enum
 	usercmd_vec_end
 };
 
-// Used by the traceresult() native.
+/**
+ * Used by the traceresult()
+ */
 enum
 {
 	TR_AllSolid,       // (int) if true, plane is not valid