docs: [ci] generate new docs

doc-iface
TorchedSammy 2022-02-25 22:15:49 +00:00 committed by GitHub Actions
parent a77b997942
commit 0bf4072355
3 changed files with 24 additions and 9 deletions

View File

@ -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

View File

@ -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

View File

@ -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