Ldoc compliant

old/modules/DONE/Core/Command/control.lua

@@ -24,7 +24,7 @@ function commands.add_middleware(callback) if not is_type(callback,'function') t
 -- @field commands.data
 -- @usage commands.command_name -- returns command data
 -- @usage commands.data -- returns all data
--- @tparam ?string|table|event key the command that will be returned: string is the name, table is the command data, event is event from add_command
+-- @tparam string table ?string|table|event key the command that will be returned: is the name, is the command data, event is event from add_command
 -- @treturn table the command data
 setmetatable(commands,{
     __index=function(tbl,key) return is_type(key,'table') and (key.command and rawget(commandDataStore,key.name) or key) or key == 'data' and commandDataStore or rawget(commandDataStore,key) end
@@ -242,9 +242,9 @@ end
 --- Used to define commands
 -- @usage --see examples in file
 -- @tparam string name the name of the command
--- @tparam[opt='No Description'] string description the description of the command
--- @tparam[opt=an infinite string] table inputs a table of the inputs to be used, last index being true makes the last parameter open ended (longer than one word)
--- @tparam function callback the function to call on the event
+-- @tparam[opt='No string Description'] description the description of the command
+-- @tparam[opt=an table table infinite string] inputs a of the inputs to be used, last index being true makes the last parameter open ended (longer than one word)
+-- @tparam function function callback the to call on the event
 commands.add_command = function(name, description, inputs, callback)
     if commands[name] then error('That command is already registered',2) end
     if not is_type(name,'string') then error('Command name has not been given') end

old/modules/DONE/Core/Group/control.lua

@@ -40,7 +40,7 @@ _GroupSelfRef=Group
 --- Defines a new instance of a group
 -- @usage Group.define{name='foo',disallow={'edit_permission_group','delete_permission_group','add_permission_group'}} -- returns new group
 -- @usage Group{name='foo',disallow={'edit_permission_group','delete_permission_group','add_permission_group'}} -- returns new group
--- @tparam table obj contains string name and table disallow of defines.input_action
+-- @tparam string table table obj contains name and disallow of defines.input_action
 -- @treturn Group the group which has been made
 function Group.define(obj)
     if not type_error(game,nil,'Cant define Group during runtime.') then return end

old/modules/DONE/Core/Gui/control.lua

@@ -48,7 +48,7 @@ end
 --- Adds a label that is centered
 -- @usage Gui.centered_label(frame, 'Hello, world!')
 -- @tparam LuaGuiElement frame the parent frame to add the label to
--- @tparam string string the string that the label will have
+-- @tparam string string string the that the label will have
 function Gui.centered_label(frame, string)
     local flow = frame.add {frame = 'flow'}
     local flow_style = flow.style

old/modules/DONE/Core/Gui/inputs/control.lua

@@ -28,7 +28,7 @@ inputs.events = {
 --- Sets the input to trigger on an certain event
 -- @usage button:on_event(defines.events.on_gui_click,player_return)
 -- @param event the event to raise callback on | can be number of the event | can be a key of inputs.events
--- @tparam function callback the function you want to run on the event
+-- @tparam function function callback the you want to run on the event
 -- @treturn table returns self so you can chain together
 function inputs._prototype:on_event(event,callback)
     if not is_type(callback,'function') then return self end
@@ -311,8 +311,8 @@ end
 -- @tparam string orientation direction of the slider
 -- @tparam number min the lowest number
 -- @tparam number max the highest number
--- @tparam function start_callback either a number or a function to return a number
--- @tparam function callback the function to be called on value_changed function(player,value,percent,element)
+-- @tparam number function function start_callback either a or a to return a number
+-- @tparam function function callback the to be called on value_changed function(player,value,percent,element)
 -- @treturn table the slider object that was made, to allow a custom error event if wanted
 function inputs.add_slider(name,orientation,min,max,start_callback,callback)
     local slider = inputs.add{

old/modules/DONE/Core/Gui/toolbar/control.lua

@@ -38,7 +38,7 @@ end)
 -- @tparam string name the name of the button
 -- @tparam string caption can be a sprite path or text to show
 -- @tparam string tooltip the help to show for the button
--- @tparam function callback the function which is called on_click
+-- @tparam function function callback the which is called on_click
 -- @treturn table the button object that was made, calling the returned value will draw the toolbar button added
 function toolbar.add(name,caption,tooltip,callback)
     verbose('Created Toolbar Button: '..name)

old/modules/DONE/Core/Role/control.lua

@@ -80,7 +80,7 @@ function Role.set_preassign(tbl) if game then global.preassign = tbl else Role.p
 --- Defines a new instance of a role
 -- @usage Role.define{name='Root',short_hand='Root',tag='[Root]',group='Root',colour={r=255,b=255,g=255},is_root=true,allow={}} -- returns new role
 -- @usage Role{name='Root',short_hand='Root',tag='[Root]',group='Root',colour={r=255,b=255,g=255},is_root=true,allow={}} -- returns new role
--- @tparam table obj contains the strings: name,short_hand,tag a table called allow a table called colour and a pointer to a permission group
+-- @tparam table table obj contains the strings: name,short_hand,tag a called allow a table called colour and a pointer to a permission group
 -- @treturn Role the role which has been made
 function Role.define(obj)
     if not type_error(game,nil,'Cant define Role during runtime.') then return end
@@ -127,7 +127,7 @@ end
 -- @usage Role.assign(player,'Root')
 -- @usage Role.assign(player,{'Root','Foo'})
 -- @tparam ?LuaPlayer|pointerToPlayer player the player to assign the role to
--- @tparam ?string|role|table the role to add the player to, if its a table then it will act recursively though the table
+-- @tparam table ?string|role|table the role to add the player to, if its a then it will act recursively though the table
 -- @tparam[opt='<server>'] ?LuaPlayer|pointerToPlayer by_player the player who assigned the roles to the player
 -- @tparam[opt] table batch this is used internally to prevent multiple event calls, contains {role_index_in_batch,batch}
 -- @treturn boolean was the player assigned the roles
@@ -153,7 +153,7 @@ end
 --- Used to remove a player from a role(s)
 -- @usage Role.unassign(player,'Root')
 -- @tparam ?LuaPlayer|pointerToPlayer player the player to unassign the role to
--- @tparam ?string|role|table role the role to remove the player from, if its a table then it will act recursively though the table
+-- @tparam table ?string|role|table role the role to remove the player from, if its a then it will act recursively though the table
 -- @tparam[opt='<server>'] ?LuaPlayer|pointerToPlayer by_player the player who unassigned the roles from the player
 -- @tparam[opt] table batch this is used internally to prevent multiple event calls
 -- @treturn boolean was the player unassigned the roles
@@ -179,7 +179,7 @@ end
 --- Returns the highest role given in a list, if a player is passed then it returns the highest role of the player
 -- @usage Role.get_highest{'Root','Admin','Mod'} -- returns Root (given that root is highest)
 -- @usage Role.get_highest(player) -- returns the players highest role
--- @tparam ?table|LuaPlayer|pointerToPlayer options table of options or a player
+-- @tparam table ?table|LuaPlayer|pointerToPlayer options of options or a player
 -- @treturn role the highest role given in the options
 function Role.get_highest(options)
     local player = Game.get_player(options)
@@ -199,7 +199,7 @@ end
 -- @usage Role.revert(player) -- reverts the last change to the players roles
 -- @tparam ?LuaPlayer|pointerToPlayer player the player to revert the changes of
 -- @tparam[opt] ?LuaPlayer|pointerToPlayer the player who preformed the role revert
--- @tparam[opt=1] count the number of reverts to do, if 0 all changes cached are reverted
+-- @tparam[opt=1] number count the of reverts to do, if 0 all changes cached are reverted
 -- @treturn number the number of changes that occurred
 function Role.revert(player,by_player,count)
     player = Game.get_player(player)
@@ -224,7 +224,7 @@ end
 --- Adds a flag which can be set on roles; these flags act as a quick way to access general role changes
 -- @usage Role.add_flag('is_admin',function(player,state) player.admin = state end) -- the function is passed player and if the flag is true or false
 -- @tparam string flag the name of the flag that is being added
--- @tparam[opt] function callback the function(player,state) which is called when a player loses or gains a flag, if nil no function is called
+-- @tparam[opt] function function callback the function(player,state) which is called when a player loses or gains a flag, if nil no is called
 function Role.add_flag(flag,callback)
     if not type_error(flag,'string','Invalid argument #1 to Role.add_flag, flag is not a string.') then return end
     if callback and not type_error(callback,'function','Invalid argument #2 to Role.add_flag, callback is not a function.') then return end