aperx/factorio-scenario-ExpCluster
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #170 from Cooldude2606/feature/ci-doc-fix

Browse Source 
Fixed doc issues raised by ci
This commit is contained in:
Cooldude2606
2020-08-06 20:00:25 +01:00
committed by GitHub
parent 5c95ea17fa e44b8d52ba
commit 24e865630f
3 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
expcore/datastore.lua
View File

@@ -437,7 +437,7 @@ function Datastore:set_serializer(callback)
end end
--[[-- Set a default value to be returned by get if no other default is given, using will mean get will never return nil, set using the default will set to nil to save space --[[-- Set a default value to be returned by get if no other default is given, using will mean get will never return nil, set using the default will set to nil to save space
@tparam any default The value that will be deep copied by get if the value is nil and no other default is given @tparam any value The value that will be deep copied by get if the value is nil and no other default is given
@tparam boolean allowSet When true if the default is passed as the value for set it will be set rather than setting nil @tparam boolean allowSet When true if the default is passed as the value for set it will be set rather than setting nil
@usage-- Set a default value to be returned by get @usage-- Set a default value to be returned by get
@@ -747,6 +747,7 @@ local function event_error(err) log('An error ocurred in a datastore event handl
@tparam string event_name The name of the event to raise for this datastore @tparam string event_name The name of the event to raise for this datastore
@tparam string key The key that this event is being raised for @tparam string key The key that this event is being raised for
@tparam[opt] any value The current value that this key has, might be a deep copy of the value @tparam[opt] any value The current value that this key has, might be a deep copy of the value
@tparam[opt] any old_value The previous value that this key has, might be a deep copy of the value
@tparam[opt] string source Where this call came from, used to do event recursion so can be parent or child @tparam[opt] string source Where this call came from, used to do event recursion so can be parent or child
@treturn any The value that is left after being passed through all the event handlers @treturn any The value that is left after being passed through all the event handlers

9
modules/control/reports.lua
View File

@@ -161,13 +161,10 @@ end
-- @tparam LuaPlayer player the player who is having the report removed from them -- @tparam LuaPlayer player the player who is having the report removed from them
-- @tparam string reported_by_name the player who had the report -- @tparam string reported_by_name the player who had the report
-- @tparam string removed_by_name the player who is clearing the report -- @tparam string removed_by_name the player who is clearing the report
<<<<<<< HEAD -- @tparam number batch the index of this event in a batch, always one when not a batch
local function report_removed_event(player, reported_by_name, removed_by_name) -- @tparam number batch_count the number of reports removed in this batch, always one when not a batch
local function report_removed_event(player, reported_by_name, removed_by_name, batch, batch_count)
script.raise_event(Reports.events.on_report_removed, { script.raise_event(Reports.events.on_report_removed, {
=======
local function report_removed_event(player,reported_by_name,removed_by_name,batch,batch_count)
script.raise_event(Reports.events.on_report_removed,{
>>>>>>> 6.0.11
name = Reports.events.on_report_removed, name = Reports.events.on_report_removed,
tick = game.tick, tick = game.tick,
player_index = player.index, player_index = player.index,

2
modules/control/warnings.lua
View File

@@ -155,6 +155,8 @@ end
-- @tparam string warning_by_name the name of the player who made the warning -- @tparam string warning_by_name the name of the player who made the warning
-- @tparam string removed_by_name the name of the player who is doing the action -- @tparam string removed_by_name the name of the player who is doing the action
-- @tparam number warning_count the number of warnings that the player how has -- @tparam number warning_count the number of warnings that the player how has
-- @tparam number batch the index of this event in a batch, always one when not a batch
-- @tparam number batch_count the number of reports removed in this batch, always one when not a batch
local function warning_removed_event(player, warning_by_name, removed_by_name, warning_count, batch, batch_count) local function warning_removed_event(player, warning_by_name, removed_by_name, warning_count, batch, batch_count)
script.raise_event(Warnings.events.on_warning_removed, { script.raise_event(Warnings.events.on_warning_removed, {
name = Warnings.events.on_warning_removed, name = Warnings.events.on_warning_removed,