From 0bf40723558c649cf5e96d3c46214d65d51cc24b Mon Sep 17 00:00:00 2001 From: TorchedSammy Date: Fri, 25 Feb 2022 22:15:49 +0000 Subject: [PATCH] docs: [ci] generate new docs --- emmyLuaDocs/bait.lua | 12 +++++++++--- emmyLuaDocs/commander.lua | 7 +++++-- emmyLuaDocs/fs.lua | 14 ++++++++++---- 3 files changed, 24 insertions(+), 9 deletions(-) diff --git a/emmyLuaDocs/bait.lua b/emmyLuaDocs/bait.lua index 72f9703..5a37afc 100644 --- a/emmyLuaDocs/bait.lua +++ b/emmyLuaDocs/bait.lua @@ -3,12 +3,18 @@ local bait = {} --- Catches a hook with `name`. Runs the `cb` when it is thrown -function bait.catch() end +--- @param name string +--- @param cb function +function bait.catch(name, cb) end --- Same as catch, but only runs the `cb` once and then removes the hook -function bait.catchOnce() end +--- @param name string +--- @param cb function +function bait.catchOnce(name, cb) end --- Throws a hook with `name` with the provided `args` -function bait.throw() end +--- @param name string +--- @vararg any +function bait.throw(name) end return bait diff --git a/emmyLuaDocs/commander.lua b/emmyLuaDocs/commander.lua index cedc581..c6738dd 100644 --- a/emmyLuaDocs/commander.lua +++ b/emmyLuaDocs/commander.lua @@ -3,9 +3,12 @@ local commander = {} --- Deregisters any command registered with `name` -function commander.deregister() end +--- @param name string +function commander.deregister(name) end --- Register a command with `name` that runs `cb` when ran -function commander.register() end +--- @param name string +--- @param cb function +function commander.register(name, cb) end return commander diff --git a/emmyLuaDocs/fs.lua b/emmyLuaDocs/fs.lua index e11163a..daedd7e 100644 --- a/emmyLuaDocs/fs.lua +++ b/emmyLuaDocs/fs.lua @@ -3,15 +3,21 @@ local fs = {} --- Changes directory to `dir` -function fs.cd() end +--- @param dir string +function fs.cd(dir) end --- Makes a directory called `name`. If `recursive` is true, it will create its parent directories. -function fs.mkdir() end +--- @param name string +--- @param recursive bool +function fs.mkdir(name, recursive) end --- Returns a table of files in `dir` -function fs.readdir() end +--- @param dir string +--- @return table +function fs.readdir(dir) end --- Returns info about `path` -function fs.stat() end +--- @param path string +function fs.stat(path) end return fs