Added Function comments

Update: EGG_0.0.3

Author: @captain1242

msync/client_gui/cl_admin_gui.lua

@@ -1,8 +1,11 @@
-AddCSLuaFile()
-
 MSync = MSync or {}
 MSync.AdminPanel = MSync.AdminPanel or {}
 
+--[[
+    Description: MySQL settings panel
+    Arguments: parent sheet
+    Returns: panel
+]]
 function MSync.AdminPanel.InitMySQL( sheet ) 
     local pnl = vgui.Create( "DPanel", sheet )
 
@@ -112,6 +115,11 @@ function MSync.AdminPanel.InitMySQL( sheet )
     return pnl
 end
 
+--[[
+    Description: Module list panel
+    Arguments: parent sheet
+    Returns: panel
+]]
 function MSync.AdminPanel.InitModules( sheet ) 
     local pnl = vgui.Create( "DPanel", sheet )
 
@@ -129,6 +137,11 @@ function MSync.AdminPanel.InitModules( sheet )
     return pnl
 end
 
+--[[
+    Description: Module settings panel
+    Arguments: parent sheet
+    Returns: panel
+]]
 function MSync.AdminPanel.InitModuleSettings( sheet ) 
     local pnl = vgui.Create( "DColumnSheet", sheet )
 
@@ -140,7 +153,10 @@ function MSync.AdminPanel.InitModuleSettings( sheet )
     return pnl
 end
 
-
+--[[
+    Description: MSync 2 panel
+    Returns: nothing
+]]
 function MSync.AdminPanel.InitPanel()
 
     --if not LocalPlayer():query("msync.admingui") then return false end;
@@ -162,4 +178,8 @@ function MSync.AdminPanel.InitPanel()
 
 end
 
+--[[
+    Description: Debug function. Remove on command implementation.
+    Returns: nothing
+]]
 MSync.AdminPanel.InitPanel()

msync/client_gui/cl_modules.lua

@@ -3,12 +3,20 @@ MSync.mysql     = MSync.mysql or {}
 MSync.settings  = MSync.settings or {}
 MSync.modules   = MSync.modules or {}
 
+--[[
+    Description: loads the client side modules
+    Returns: nothing
+]]
 function MSync.loadModules()
     for k, v in pairs(file.Find("msync/client_gui/modules/*.lua", "LUA")[1]) do
         include("msync/client_gui/modules/"..v)
     end
 end
 
+--[[
+    Description: initializes the client modules
+    Returns: nothing
+]]
 function MSync.initModules()
 
     for k,v in pairs(MSync.Modules) do
@@ -21,26 +29,20 @@ function MSync.initModules()
 
 end
 
+--[[
+    Description: loads a single client side module
+    Arguments: Module path
+    Returns: nothing
+]]
 function MSync.loadModule(path)
     local initTransaction = MSync.DBServer:createTransaction()
     local info = include(path)
 
-    MSync.modules[info.ModuleIdentifier].init(initTransaction)
+    MSync.modules[info.ModuleIdentifier].init()
     MSync.modules[info.ModuleIdentifier].net()
     MSync.modules[info.ModuleIdentifier].ulx()
     MSync.modules[info.ModuleIdentifier].hooks()
 
     print("["..MSync.modules[info.Name].."] Module loaded")
 
-    function initTransaction.onSuccess()
-        print("[MSync] Module query has been completed successfully")
-        MSync.mysql[info.ModuleIdentifier].dbstatus = true
-    end
-
-    function initTransaction.onError(tr, err)
-        print("[MSync] There has been a error while loading the module querys.\nPlease inform the Developer and send him this:\n"..err)
-        MSync.mysql[info.ModuleIdentifier].dbstatus = false
-    end
-
-    initTransaction:start()
 end

msync/client_gui/cl_net.lua

@@ -1,22 +1,38 @@
 MSync = MSync or {}
 MSync.net = MSync.net or {}
 
+--[[
+    Description: Function to get the server settings
+    Returns: nothing
+]]
 function MSync.net.getSettings()
     net.Start("msync.getSettings")
     net.SendToServer()
 end
 
+--[[
+    Description: function to get the modules
+    Returns: nothing
+]]
 function MSync.net.getModules()
     net.Start("msync.getModules")
     net.SendToServer()
 end
 
+--[[
+    Description: function to send settngs to the server
+    Returns: nothing
+]]
 function MSync.net.sendSettings(table)
     net.Start("msync.sendSettings")
         net.WriteTable(table)
     net.SendToServer()
 end
 
+--[[
+    Description: Net Receiver - Gets called when the server sends a table to the client
+    Returns: nothing
+]]
 net.Receive( "msync.sendTable", function( len, pl )
     local type = net.ReadString()
     local table = net.ReadTable()
@@ -25,6 +41,10 @@ net.Receive( "msync.sendTable", function( len, pl )
     elseif type == "modules" then MSync.serverModules = table end
 end )
 
+--[[
+    Description:  Net Receiver - Gets called when the server sends a message to the client
+    Returns: nothing
+]]
 net.Receive( "msync.sendMessage", function( len, pl )
     local state = net.ReadString()
 

msync/server/sv_hooks.lua

@@ -1,13 +1,26 @@
+--[[
+    Description: hook to initialize MSync 2
+    Returns: nothing
+]]
 hook.Add( "Initialize", "msync.initScript", function()
     MSync.function.loadSettings()
-
+    
+    --[[
+        Description: timer to prevent loading before ULX
+        Returns: nothing
+    ]]        
     timer.Create("msync.checkForULXandULib", 5, 0, function()
         if not ULX and ULib then return end;
 
         MSync.mysql.initialize() 
+        MSync.ulx.createPermissions()
     end)
 end)
 
+--[[
+        Description: Creates a entry to the database for every player that joins.
+        Returns: nothing
+    ]]     
 hook.Add("PlayerInitialSpawn", "msync.createUser", function( ply )
     MSync.mysql.addUser(ply)
 end)

msync/server/sv_init.lua

@@ -5,7 +5,10 @@ MSync.modules = MSync.modules or {}
 MSync.settings  = MSync.settings or {}
 MSync.function  = MSync.function or {}
 
-
+--[[
+    Description: Function to load the server side files
+    Returns: nothing
+]]
 function MSync.function.loadServer()
 
     include("/msync/server/sv_net.lua")
@@ -15,6 +18,10 @@ function MSync.function.loadServer()
 
 end
 
+--[[
+    Description: Function to load the MSync settings file
+    Returns: true
+]]
 function MSync.function.loadSettings()
     if not file.Exists("msync/settings.txt", "DATA") then
         MSync.settings.data = {
@@ -39,11 +46,19 @@ function MSync.function.loadSettings()
     return true
 end
 
+--[[
+    Description: Function to save the MSync settings to the settings file
+    Returns: true if the settings file exists
+]]
 function MSync.function.saveSettings()
     file.Write("msync/settings.txt", util.TableToJSON(MSync.settings.data, true))
     return file.Exists("msync/settings.txt", "DATA")
 end
 
+--[[
+    Description: Function to get a table of the module informations
+    Returns: table with Module informations
+]]
 function MSync.function.getModuleInfos()
     local infoTable = {}
 
@@ -55,6 +70,11 @@ function MSync.function.getModuleInfos()
     return infoTable
 end
 
+--[[
+    Description: Function to return settings without the MySQL password
+                We have decided that its better to Re-Enter the password always, and not be able to see the MySQL password client side
+    Returns: safe settings table
+]]
 function MSync.function.getSafeSettings()
     local settings = MSync.settings.data
     settings.mysql.password = nil

msync/server/sv_modules.lua

@@ -3,12 +3,20 @@ MSync.mysql     = MSync.mysql or {}
 MSync.settings  = MSync.settings or {}
 MSync.modules   = MSync.modules or {}
 
+--[[
+    Description: Loads all server side modules
+    Returns: nothing
+]]     
 function MSync.loadModules()
     for k, v in pairs(file.Find("msync/server/modules/*.lua", "LUA")[1]) do
         include("msync/server/modules/"..v)
     end
 end
 
+--[[
+    Description: initializes all modules
+    Returns: nothing
+]]   
 function MSync.initModules()
     MSync.mysql.dbstatus = false
     if MSync.DBServer then
@@ -39,6 +47,11 @@ function MSync.initModules()
     end
 end
 
+--[[
+    Description: Loads single modules
+    Arguments: path to module
+    Returns: nothing
+]]   
 function MSync.loadModule(path)
     local initTransaction = MSync.DBServer:createTransaction()
     local info = include(path)

msync/server/sv_mysql.lua

@@ -4,6 +4,10 @@ MSync.mysql     = MSync.mysql or {}
 MSync.settings  = MSync.settings or {}
 MSync.function  = MSync.function or {}
 
+--[[
+    Description: initializes the MySQL part
+    Returns: nothing
+]]   
 function MSync.mysql.initialize() 
     if (file.Exists( "bin/gmsv_mysqloo_linux.dll", "LUA" ) or file.Exists( "bin/gmsv_mysqloo_win32.dll", "LUA" )) and MSync.settings.data.mysql then
         require("mysqloo")
@@ -73,6 +77,11 @@ function MSync.mysql.initialize()
     end
 end
 
+--[[
+    Description: Adds a user to the users table
+    Arguments: player
+    Returns: nothing
+]]   
 function MSync.mysql.addUser(ply)
     if not MSync.DBServer then print("[MSync] No Database connected yet. Please connect to a Database to be able to create users."); return end;
 
@@ -95,6 +104,10 @@ function MSync.mysql.addUser(ply)
     addUserQ:start()
 end
 
+--[[
+    Description: Function to print the MySQL informations to the console
+    Returns: nothing
+]]   
 function MSync.mysql.getInfo() 
     print("--Database Server Information--")
     print("Version: "..MSync.DBServer:serverVersion())

msync/server/sv_net.lua

@@ -1,8 +1,16 @@
 MSync = MSync or {}
 MSync.net = MSync.net or {}
 
+--[[
+    Description: Function to send a table to the client
+    Arguments:
+        player [player] - the player to send the table to
+        identifier [string] - what kind of table you are sending to the client
+        table [table] - the table you send
+    Returns: nothing
+]]   
 function MSync.net.sendTable(ply, identifier, table)
-    identifier = identifier or "settings"
+    local identifier = identifier or "settings"
 
     net.Start("msync.sendTable")
         net.WriteString(identifier)
@@ -11,8 +19,16 @@ function MSync.net.sendTable(ply, identifier, table)
 
 end
 
+--[[
+    Description: Function to send a text message to the client
+    Arguments:
+        player [player] - the player you want to send the message to
+        state [string] - the state of the message, can be "info", "error", "advert"
+        message [string] - the message you want to send to the client
+    Returns: nothing
+]]   
 function MSync.net.sendMessage(ply, state, string)
-    state = state or "info"
+    local state = state or "info"
 
     net.Start("msync.sendMessage")
         net.WriteString(state)
@@ -21,26 +37,42 @@ function MSync.net.sendMessage(ply, state, string)
 
 end
 
+--[[
+    Description: Net Receiver - Gets called when the client requests a table
+    Returns: nothing
+]]   
 net.Receive("msync.getTable", function(len, ply)
     if not ply:query("msync.getTable") then return end
 
     local identifier = net.ReadString()
     MSync.net.sendTable(ply, identifier, MSync[identifier])
 end )
 
+--[[
+    Description: Net Receiver - Gets called when the client sends the settings table to the server
+    Returns: nothing
+]]   
 net.Receive("msync.sendSettings", function(len, ply)
     if not ply:query("msync.sendSettings") then return end
 
     MSync.settings.data = net.ReadTable()
     MSync.function.saveSettings()
 end )
 
+--[[
+    Description: Net Receiver - Gets called when the client requests the settings table
+    Returns: nothing
+]]   
 net.Receive("msync.getSettings", function(len, ply)
     if not ply:query("msync.getSettings") then return end
 
     MSync.net.sendTable(ply, "settings", MSync.function.getSafeSettings())
 end )
 
+--[[
+    Description: Net Receiver - Gets called when the client requests the module table
+    Returns: nothing
+]]   
 net.Receive("msync.getModules", function(len, ply)
     if not ply:query("msync.getModules") then return end