Added LDoc comments for new files, ready to merge pt. 2

This commit is contained in:
SkylarHew
2022-01-23 18:21:23 -07:00
parent e72911c67c
commit 79b548f9a0
24 changed files with 118 additions and 94 deletions

View File

@ -1,5 +1,5 @@
--- @module randomizer
-- A utility module that outputs a random result from a set of options
--- A utility module that outputs a random result from a set of options
-- @module randomizer
local randomizer = {
name = "Randomizer",
@ -18,6 +18,9 @@ randomizer.config = {
result_table = {}
}
--- Initiate function
-- @function randomizer:initiate
-- @param result Callback if this module is embedded in other modules
function randomizer:initiate(result)
self.data.result = result
self.data.options_table = modpol.util.copy_table(self.config.options_table)
@ -32,7 +35,8 @@ function randomizer:initiate(result)
end
end
-- returns result_table
--- Returns result_table
-- @function randomizer:random_loop
function randomizer:random_loop()
self.data.results = 0
if results == self.config.num_results then