From d46c079afbaae33d0e28bf3813549aafc38e7b88 Mon Sep 17 00:00:00 2001 From: TorchedSammy Date: Sun, 28 Apr 2024 01:29:33 +0000 Subject: [PATCH] docs: [ci] generate new docs --- docs/api/commander.md | 17 +++++++++++++++++ emmyLuaDocs/commander.lua | 4 ++++ 2 files changed, 21 insertions(+) diff --git a/docs/api/commander.md b/docs/api/commander.md index c26445a..b910706 100644 --- a/docs/api/commander.md +++ b/docs/api/commander.md @@ -44,6 +44,7 @@ This sink is for writing errors, as the name would suggest. |----|----| |deregister(name)|Removes the named command. Note that this will only remove Commander-registered commands.| |register(name, cb)|Adds a new command with the given `name`. When Hilbish has to run a command with a name,| +|registry() -> table|Returns all registered commanders. Returns a list of tables with the following keys:|
@@ -94,3 +95,19 @@ end) ```
+
+
+

+commander.registry() -> table + + + +

+ +Returns all registered commanders. Returns a list of tables with the following keys: +- `exec`: The function used to run the commander. Commanders require args and sinks to be passed. + +#### Parameters +This function has no parameters. +
+ diff --git a/emmyLuaDocs/commander.lua b/emmyLuaDocs/commander.lua index 285c4b5..bfa69e5 100644 --- a/emmyLuaDocs/commander.lua +++ b/emmyLuaDocs/commander.lua @@ -11,4 +11,8 @@ function commander.deregister(name) end --- function commander.register(name, cb) end +--- Returns all registered commanders. Returns a list of tables with the following keys: +--- - `exec`: The function used to run the commander. Commanders require args and sinks to be passed. +function commander.registry() end + return commander