diff --git a/frontend/dump.lua b/frontend/dump.lua index 4e5f77413..5bb5de274 100644 --- a/frontend/dump.lua +++ b/frontend/dump.lua @@ -1,5 +1,5 @@ ---[[ -simple serialization function, won't do uservalues, functions, loops +--[[-- +A simple serialization function which won't do uservalues, functions, or loops. ]] local isUbuntuTouch = os.getenv("UBUNTU_APPLICATION_ISOLATION") ~= nil @@ -66,10 +66,12 @@ local function _serialize(what, outt, indent, max_lv, history) end end ---[[ -Serializes whatever is in "data" to a string that is parseable by Lua +--[[--Serializes whatever is in `data` to a string that is parseable by Lua. -You can optionally specify a maximum recursion depth in "max_lv" +You can optionally specify a maximum recursion depth in `max_lv`. +@function dump +@param data the object you want serialized (table, string, number, boolean, nil) +@param max_lv optional maximum recursion depth --]] local function dump(data, max_lv) local out = {} diff --git a/frontend/random.lua b/frontend/random.lua index 954a3214c..6c2eb579c 100644 --- a/frontend/random.lua +++ b/frontend/random.lua @@ -1,15 +1,15 @@ --- A set of functions to extend math.random and math.randomseed. +--- A set of functions to extend math.random and math.randomseed. local random = {} --- Use current time as seed to randomlize. +--- Uses current time as seed to randomize. function random.seed() math.randomseed(os.time()) end random.seed() --- Return a UUID (v4, random). +--- Returns a UUID (v4, random). function random.uuid(with_dash) local array = {} for i = 1, 16 do