Updated Doc

modules/ExpGamingCore/Sync/control.lua

@@ -6,30 +6,52 @@
 
 local Sync = {}
 local Sync_updates = {}
+
 --- Global Table
 -- @table global
+-- @field server_name the server name
+-- @field server_description a short description of the server
+-- @field reset_time the reset time of the server
+-- @field time the last knowen irl time
+-- @field time_set the last in game time that the time was set
+-- @field last_update the last time that this info was updated
+-- @field time_period how often this infomation is updated
+-- @field players a list of different player related states
+-- @field ranks a list of player ranks
+-- @field rockets the number of rockets launched
+-- @field mods the mods which are loaded
 local global = global{
-    server_name='Factorio Server', -- the server name
-    server_description='A factorio server for everyone', -- a short description of the server
-    reset_time='On Demand', -- the reset time of the server
-    time='Day Mth 00 00:00:00 UTC Year', -- the last knowen irl time
-    time_set={0,'0.00M'}, -- the last in game time that the time was set
-    last_update={0,'0.00M'}, -- the last time that this info was updated
-    time_period={18000,'5.00M'}, -- how often this infomation is updated
+    server_name='Factorio Server',
+    server_description='A factorio server for everyone',
+    reset_time='On Demand',
+    time='Day Mth 00 00:00:00 UTC Year',
+    time_set={0,'0.00M'},
+    last_update={0,'0.00M'},
+    time_period={18000,'5.00M'},
     players={
-        online={'Offline'}, -- list of all players online
-        n_online=0, -- the number of players online
-        all={'Offline'}, -- list of all player on or offline
-        n_all=0, -- the number of players who have joined the server
-        admins_online=0, -- the number of admins online
-        afk_players=0, -- the number of afk players
-        times={'Offline'} -- the play times of every player
-    }, -- a sub list of players in the game
-    ranks={'Offline'}, -- a list of player ranks
-    rockets=0, -- the number of rockets launched
-    mods={'Offline'} -- the mods which are loaded
+        online={'Offline'},
+        n_online=0,
+        all={'Offline'},
+        n_all=0,
+        admins_online=0,
+        afk_players=0,
+        times={'Offline'} 
+    },
+    ranks={'Offline'},
+    rockets=0,
+    mods={'Offline'}
 }
 
+--- Player sub-table
+-- @table global.players
+-- @field online list of all players online
+-- @field n_online the number of players online
+-- @field all list of all player on or offline
+-- @field n_all the number of players who have joined the server
+-- @field admins_online the number of admins online
+-- @field afk_players the number of afk players
+-- @field times the play times of every player
+
 --- Used to standidise the tick format for any sync info
 -- @usage Sync.tick_format(60) -- return {60,'1.00M'}
 -- @treturn {number,string} table containg both the raw number and clean version of a time