diff --git a/cmd/docgen/docgen.go b/cmd/docgen/docgen.go
index aae6202..9008cca 100644
--- a/cmd/docgen/docgen.go
+++ b/cmd/docgen/docgen.go
@@ -43,6 +43,12 @@ type module struct {
HasTypes bool
}
+type param struct{
+ Name string
+ Type string
+ Doc []string
+}
+
type docPiece struct {
Doc []string
FuncSig string
@@ -55,6 +61,7 @@ type docPiece struct {
IsType bool
Fields []docPiece
Properties []docPiece
+ Params []param
}
type tag struct {
@@ -215,6 +222,17 @@ start:
fields := docPieceTag("field", tags)
properties := docPieceTag("property", tags)
+ var params []param
+ if paramsRaw := tags["param"]; paramsRaw != nil {
+ params = make([]param, len(paramsRaw))
+ for i, p := range paramsRaw {
+ params[i] = param{
+ Name: p.id,
+ Type: p.fields[0],
+ Doc: p.fields[1:],
+ }
+ }
+ }
for _, d := range doc {
if strings.HasPrefix(d, "---") {
@@ -252,6 +270,7 @@ start:
ParentModule: parentMod,
Fields: fields,
Properties: properties,
+ Params: params,
}
if strings.HasSuffix(dps.GoFuncName, strings.ToLower("loader")) {
dps.Doc = parts
@@ -412,7 +431,7 @@ func main() {
defer wg.Done()
modOrIface := "Module"
if modu.ParentModule != "" {
- modOrIface = "Interface"
+ modOrIface = "Module"
}
f, _ := os.Create(docPath)
@@ -454,7 +473,7 @@ func main() {
if dps.IsMember {
continue
}
- htmlSig := typeTag.ReplaceAllStringFunc(strings.Replace(dps.FuncSig, "<", `\<`, -1), func(typ string) string {
+ htmlSig := typeTag.ReplaceAllStringFunc(strings.Replace(modname + "." + dps.FuncSig, "<", `\<`, -1), func(typ string) string {
typName := typ[1:]
typLookup := typeTable[strings.ToLower(typName)]
ifaces := typLookup[0] + "." + typLookup[1] + "/"
@@ -462,7 +481,7 @@ func main() {
ifaces = ""
}
linkedTyp := fmt.Sprintf("/Hilbish/docs/api/%s/%s#%s", typLookup[0], ifaces, strings.ToLower(typName))
- return fmt.Sprintf(`%s`, linkedTyp, typName)
+ return fmt.Sprintf(`%s`, linkedTyp, typName)
})
f.WriteString(fmt.Sprintf("### %s\n", htmlSig))
for _, doc := range dps.Doc {
@@ -470,6 +489,26 @@ func main() {
f.WriteString(doc + "\n")
}
}
+ f.WriteString("#### Parameters\n")
+ if len(dps.Params) == 0 {
+ f.WriteString("This function has no parameters. \n")
+ }
+ for _, p := range dps.Params {
+ isVariadic := false
+ typ := p.Type
+ if strings.HasPrefix(p.Type, "...") {
+ isVariadic = true
+ typ = p.Type[3:]
+ }
+
+ f.WriteString(fmt.Sprintf("`%s` **`%s`**", typ, p.Name))
+ if isVariadic {
+ f.WriteString(" (This type is variadic. You can pass an infinite amount of parameters with this type.)")
+ }
+ f.WriteString(" \n")
+ f.WriteString(strings.Join(p.Doc, " "))
+ f.WriteString("\n\n")
+ }
f.WriteString("\n")
}
}
diff --git a/docs/api/bait.md b/docs/api/bait.md
index a70eb17..5929bbd 100644
--- a/docs/api/bait.md
+++ b/docs/api/bait.md
@@ -15,20 +15,35 @@ happened, like when you've changed directory, a command has failed,
etc. To find all available hooks thrown by Hilbish, see doc hooks.
## Functions
-### catch(name, cb)
+### bait.catch(name, cb)
Catches a hook with `name`. Runs the `cb` when it is thrown
+#### Parameters
+This function has no parameters.
-### catchOnce(name, cb)
+### bait.catchOnce(name, cb)
Same as catch, but only runs the `cb` once and then removes the hook
+#### Parameters
+This function has no parameters.
-### hooks(name) -> table
+### bait.hooks(name) -> table
Returns a table with hooks (callback functions) on the event with `name`.
+#### Parameters
+This function has no parameters.
-### release(name, catcher)
+### bait.release(name, catcher)
Removes the `catcher` for the event with `name`.
For this to work, `catcher` has to be the same function used to catch
an event, like one saved to a variable.
+#### Parameters
+This function has no parameters.
-### throw(name, ...args)
+### bait.throw(name, ...args)
Throws a hook with `name` with the provided `args`
+#### Parameters
+`string` **`name`**
+The name of the hook.
+
+`any` **`args`** (This type is variadic. You can pass an infinite amount of parameters with this type.)
+The arguments to pass to the hook.
+
diff --git a/docs/api/commander.md b/docs/api/commander.md
index 341eeda..aa0849e 100644
--- a/docs/api/commander.md
+++ b/docs/api/commander.md
@@ -38,9 +38,13 @@ output should go.
name would suggest.
## Functions
-### deregister(name)
+### commander.deregister(name)
Deregisters any command registered with `name`
+#### Parameters
+This function has no parameters.
-### register(name, cb)
+### commander.register(name, cb)
Register a command with `name` that runs `cb` when ran
+#### Parameters
+This function has no parameters.
diff --git a/docs/api/fs.md b/docs/api/fs.md
index ee6949f..e6e8f87 100644
--- a/docs/api/fs.md
+++ b/docs/api/fs.md
@@ -13,39 +13,57 @@ and other things, and acts an addition to the Lua standard library's
I/O and filesystem functions.
## Functions
-### abs(path) -> string
+### fs.abs(path) -> string
Gives an absolute version of `path`.
+#### Parameters
+This function has no parameters.
-### basename(path) -> string
+### fs.basename(path) -> string
Gives the basename of `path`. For the rules,
see Go's filepath.Base
+#### Parameters
+This function has no parameters.
-### cd(dir)
+### fs.cd(dir)
Changes directory to `dir`
+#### Parameters
+This function has no parameters.
-### dir(path) -> string
+### fs.dir(path) -> string
Returns the directory part of `path`. For the rules, see Go's
filepath.Dir
+#### Parameters
+This function has no parameters.
-### glob(pattern) -> matches (table)
+### fs.glob(pattern) -> matches (table)
Glob all files and directories that match the pattern.
For the rules, see Go's filepath.Glob
+#### Parameters
+This function has no parameters.
-### join(...) -> string
+### fs.join(...) -> string
Takes paths and joins them together with the OS's
directory separator (forward or backward slash).
+#### Parameters
+This function has no parameters.
-### mkdir(name, recursive)
+### fs.mkdir(name, recursive)
Makes a directory called `name`. If `recursive` is true, it will create its parent directories.
+#### Parameters
+This function has no parameters.
-### readdir(dir) -> {}
+### fs.readdir(dir) -> {}
Returns a table of files in `dir`.
+#### Parameters
+This function has no parameters.
-### stat(path) -> {}
+### fs.stat(path) -> {}
Returns a table of info about the `path`.
It contains the following keys:
name (string) - Name of the path
size (number) - Size of the path
mode (string) - Permission mode in an octal format string (with leading 0)
isDir (boolean) - If the path is a directory
+#### Parameters
+This function has no parameters.
diff --git a/docs/api/hilbish/_index.md b/docs/api/hilbish/_index.md
index 4cf0180..9ebd21a 100644
--- a/docs/api/hilbish/_index.md
+++ b/docs/api/hilbish/_index.md
@@ -23,29 +23,41 @@ interfaces and functions which directly relate to shell functionality.
- `exitCode`: xit code of the last executed command
## Functions
-### alias(cmd, orig)
+### hilbish.alias(cmd, orig)
Sets an alias of `cmd` to `orig`
+#### Parameters
+This function has no parameters.
-### appendPath(dir)
+### hilbish.appendPath(dir)
Appends `dir` to $PATH
+#### Parameters
+This function has no parameters.
-### complete(scope, cb)
+### hilbish.complete(scope, cb)
Registers a completion handler for `scope`.
A `scope` is currently only expected to be `command.`,
replacing with the name of the command (for example `command.git`).
`cb` must be a function that returns a table of "completion groups."
Check `doc completions` for more information.
+#### Parameters
+This function has no parameters.
-### cwd() -> string
+### hilbish.cwd() -> string
Returns the current directory of the shell
+#### Parameters
+This function has no parameters.
-### exec(cmd)
+### hilbish.exec(cmd)
Replaces running hilbish with `cmd`
+#### Parameters
+This function has no parameters.
-### goro(fn)
+### hilbish.goro(fn)
Puts `fn` in a goroutine
+#### Parameters
+This function has no parameters.
-### highlighter(line)
+### hilbish.highlighter(line)
Line highlighter handler. This is mainly for syntax highlighting, but in
reality could set the input of the prompt to *display* anything. The
callback is passed the current line and is expected to return a line that
@@ -58,59 +70,83 @@ function hilbish.highlighter(line)
end
```
This code will highlight all double quoted strings in green.
+#### Parameters
+This function has no parameters.
-### hinter(line, pos)
+### hilbish.hinter(line, pos)
The command line hint handler. It gets called on every key insert to
determine what text to use as an inline hint. It is passed the current
line and cursor position. It is expected to return a string which is used
as the text for the hint. This is by default a shim. To set hints,
override this function with your custom handler.
+#### Parameters
+This function has no parameters.
-### inputMode(mode)
+### hilbish.inputMode(mode)
Sets the input mode for Hilbish's line reader. Accepts either emacs or vim
+#### Parameters
+This function has no parameters.
-### interval(cb, time) -> Timer
+### hilbish.interval(cb, time) -> Timer
Runs the `cb` function every `time` milliseconds.
This creates a timer that starts immediately.
+#### Parameters
+This function has no parameters.
-### multiprompt(str)
+### hilbish.multiprompt(str)
Changes the continued line prompt to `str`
+#### Parameters
+This function has no parameters.
-### prependPath(dir)
+### hilbish.prependPath(dir)
Prepends `dir` to $PATH
+#### Parameters
+This function has no parameters.
-### prompt(str, typ)
+### hilbish.prompt(str, typ)
Changes the shell prompt to `str`
There are a few verbs that can be used in the prompt text.
These will be formatted and replaced with the appropriate values.
`%d` - Current working directory
`%u` - Name of current user
`%h` - Hostname of device
+#### Parameters
+This function has no parameters.
-### read(prompt) -> input (string)
+### hilbish.read(prompt) -> input (string)
Read input from the user, using Hilbish's line editor/input reader.
This is a separate instance from the one Hilbish actually uses.
Returns `input`, will be nil if ctrl + d is pressed, or an error occurs (which shouldn't happen)
+#### Parameters
+This function has no parameters.
-### run(cmd, returnOut) -> exitCode (number), stdout (string), stderr (string)
+### hilbish.run(cmd, returnOut) -> exitCode (number), stdout (string), stderr (string)
Runs `cmd` in Hilbish's sh interpreter.
If returnOut is true, the outputs of `cmd` will be returned as the 2nd and
3rd values instead of being outputted to the terminal.
+#### Parameters
+This function has no parameters.
-### runnerMode(mode)
+### hilbish.runnerMode(mode)
Sets the execution/runner mode for interactive Hilbish. This determines whether
Hilbish wll try to run input as Lua and/or sh or only do one of either.
Accepted values for mode are hybrid (the default), hybridRev (sh first then Lua),
sh, and lua. It also accepts a function, to which if it is passed one
will call it to execute user input instead.
+#### Parameters
+This function has no parameters.
-### timeout(cb, time) -> Timer
+### hilbish.timeout(cb, time) -> Timer
Runs the `cb` function after `time` in milliseconds.
This creates a timer that starts immediately.
+#### Parameters
+This function has no parameters.
-### which(name) -> string
+### hilbish.which(name) -> string
Checks if `name` is a valid command.
Will return the path of the binary, or a basename if it's a commander.
+#### Parameters
+This function has no parameters.
## Types
## Sink
diff --git a/docs/api/hilbish/hilbish.aliases.md b/docs/api/hilbish/hilbish.aliases.md
index bae5bfc..1936b47 100644
--- a/docs/api/hilbish/hilbish.aliases.md
+++ b/docs/api/hilbish/hilbish.aliases.md
@@ -1,5 +1,5 @@
---
-title: Interface hilbish.aliases
+title: Module hilbish.aliases
description: command aliasing
layout: doc
menu:
@@ -11,15 +11,23 @@ menu:
The alias interface deals with all command aliases in Hilbish.
## Functions
-### add(alias, cmd)
+### hilbish.aliases.add(alias, cmd)
This is an alias (ha) for the `hilbish.alias` function.
+#### Parameters
+This function has no parameters.
-### delete(name)
+### hilbish.aliases.delete(name)
Removes an alias.
+#### Parameters
+This function has no parameters.
-### list() -> table\
+### hilbish.aliases.list() -> table\
Get a table of all aliases, with string keys as the alias and the value as the command.
+#### Parameters
+This function has no parameters.
-### resolve(alias) -> command (string)
+### hilbish.aliases.resolve(alias) -> command (string)
Tries to resolve an alias to its command.
+#### Parameters
+This function has no parameters.
diff --git a/docs/api/hilbish/hilbish.completions.md b/docs/api/hilbish/hilbish.completions.md
index 6f8740f..6ec1206 100644
--- a/docs/api/hilbish/hilbish.completions.md
+++ b/docs/api/hilbish/hilbish.completions.md
@@ -1,5 +1,5 @@
---
-title: Interface hilbish.completions
+title: Module hilbish.completions
description: tab completions
layout: doc
menu:
@@ -11,19 +11,27 @@ menu:
The completions interface deals with tab completions.
## Functions
-### call(name, query, ctx, fields) -> completionGroups (table), prefix (string)
+### hilbish.completions.call(name, query, ctx, fields) -> completionGroups (table), prefix (string)
Calls a completer function. This is mainly used to call
a command completer, which will have a `name` in the form
of `command.name`, example: `command.git`.
You can check `doc completions` for info on the `completionGroups` return value.
+#### Parameters
+This function has no parameters.
-### handler(line, pos)
+### hilbish.completions.handler(line, pos)
The handler function is the callback for tab completion in Hilbish.
You can check the completions doc for more info.
+#### Parameters
+This function has no parameters.
-### bins(query, ctx, fields) -> entries (table), prefix (string)
+### hilbish.completions.bins(query, ctx, fields) -> entries (table), prefix (string)
Returns binary/executale completion candidates based on the provided query.
+#### Parameters
+This function has no parameters.
-### files(query, ctx, fields) -> entries (table), prefix (string)
+### hilbish.completions.files(query, ctx, fields) -> entries (table), prefix (string)
Returns file completion candidates based on the provided query.
+#### Parameters
+This function has no parameters.
diff --git a/docs/api/hilbish/hilbish.editor.md b/docs/api/hilbish/hilbish.editor.md
index 30a3842..e10aca9 100644
--- a/docs/api/hilbish/hilbish.editor.md
+++ b/docs/api/hilbish/hilbish.editor.md
@@ -1,5 +1,5 @@
---
-title: Interface hilbish.editor
+title: Module hilbish.editor
description: interactions for Hilbish's line reader
layout: doc
menu:
@@ -12,15 +12,23 @@ The hilbish.editor interface provides functions to
directly interact with the line editor in use.
## Functions
-### getLine() -> string
+### hilbish.editor.getLine() -> string
Returns the current input line.
+#### Parameters
+This function has no parameters.
-### getVimRegister(register) -> string
+### hilbish.editor.getVimRegister(register) -> string
Returns the text that is at the register.
+#### Parameters
+This function has no parameters.
-### insert(text)
+### hilbish.editor.insert(text)
Inserts text into the line.
+#### Parameters
+This function has no parameters.
-### setVimRegister(register, text)
+### hilbish.editor.setVimRegister(register, text)
Sets the vim register at `register` to hold the passed text.
+#### Parameters
+This function has no parameters.
diff --git a/docs/api/hilbish/hilbish.history.md b/docs/api/hilbish/hilbish.history.md
index 9fa9b01..902155f 100644
--- a/docs/api/hilbish/hilbish.history.md
+++ b/docs/api/hilbish/hilbish.history.md
@@ -1,5 +1,5 @@
---
-title: Interface hilbish.history
+title: Module hilbish.history
description: command history
layout: doc
menu:
@@ -13,18 +13,28 @@ This includes the ability to override functions to change the main
method of saving history.
## Functions
-### add(cmd)
+### hilbish.history.add(cmd)
Adds a command to the history.
+#### Parameters
+This function has no parameters.
-### all() -> table
+### hilbish.history.all() -> table
Retrieves all history.
+#### Parameters
+This function has no parameters.
-### clear()
+### hilbish.history.clear()
Deletes all commands from the history.
+#### Parameters
+This function has no parameters.
-### get(idx)
+### hilbish.history.get(idx)
Retrieves a command from the history based on the `idx`.
+#### Parameters
+This function has no parameters.
-### size() -> number
+### hilbish.history.size() -> number
Returns the amount of commands in the history.
+#### Parameters
+This function has no parameters.
diff --git a/docs/api/hilbish/hilbish.jobs.md b/docs/api/hilbish/hilbish.jobs.md
index e41be2c..5f8992d 100644
--- a/docs/api/hilbish/hilbish.jobs.md
+++ b/docs/api/hilbish/hilbish.jobs.md
@@ -1,5 +1,5 @@
---
-title: Interface hilbish.jobs
+title: Module hilbish.jobs
description: background job management
layout: doc
menu:
@@ -15,20 +15,30 @@ Jobs are the name of background tasks/commands. A job can be started via
interactive usage or with the functions defined below for use in external runners.
## Functions
-### add(cmdstr, args, execPath)
+### hilbish.jobs.add(cmdstr, args, execPath)
Adds a new job to the job table. Note that this does not immediately run it.
+#### Parameters
+This function has no parameters.
-### all() -> table\<Job>
+### hilbish.jobs.all() -> table\<Job>
Returns a table of all job objects.
+#### Parameters
+This function has no parameters.
-### disown(id)
+### hilbish.jobs.disown(id)
Disowns a job. This deletes it from the job table.
+#### Parameters
+This function has no parameters.
-### get(id) -> Job
+### hilbish.jobs.get(id) -> Job
Get a job object via its ID.
+#### Parameters
+This function has no parameters.
-### last() -> Job
+### hilbish.jobs.last() -> Job
Returns the last added job from the table.
+#### Parameters
+This function has no parameters.
## Types
## Job
diff --git a/docs/api/hilbish/hilbish.os.md b/docs/api/hilbish/hilbish.os.md
index aa2198e..00196da 100644
--- a/docs/api/hilbish/hilbish.os.md
+++ b/docs/api/hilbish/hilbish.os.md
@@ -1,5 +1,5 @@
---
-title: Interface hilbish.os
+title: Module hilbish.os
description: OS Info
layout: doc
menu:
diff --git a/docs/api/hilbish/hilbish.runner.md b/docs/api/hilbish/hilbish.runner.md
index 68ffdc6..7729bdd 100644
--- a/docs/api/hilbish/hilbish.runner.md
+++ b/docs/api/hilbish/hilbish.runner.md
@@ -1,5 +1,5 @@
---
-title: Interface hilbish.runner
+title: Module hilbish.runner
description: interactive command runner customization
layout: doc
menu:
@@ -15,17 +15,23 @@ language or script of their choosing. A good example is using it to
write command in Fennel.
## Functions
-### setMode(cb)
+### hilbish.runner.setMode(cb)
This is the same as the `hilbish.runnerMode` function. It takes a callback,
which will be used to execute all interactive input.
In normal cases, neither callbacks should be overrided by the user,
as the higher level functions listed below this will handle it.
+#### Parameters
+This function has no parameters.
-### lua(cmd)
+### hilbish.runner.lua(cmd)
Evaluates `cmd` as Lua input. This is the same as using `dofile`
or `load`, but is appropriated for the runner interface.
+#### Parameters
+This function has no parameters.
-### sh(cmd)
+### hilbish.runner.sh(cmd)
Runs a command in Hilbish's shell script interpreter.
This is the equivalent of using `source`.
+#### Parameters
+This function has no parameters.
diff --git a/docs/api/hilbish/hilbish.timers.md b/docs/api/hilbish/hilbish.timers.md
index e899d1d..576c820 100644
--- a/docs/api/hilbish/hilbish.timers.md
+++ b/docs/api/hilbish/hilbish.timers.md
@@ -1,5 +1,5 @@
---
-title: Interface hilbish.timers
+title: Module hilbish.timers
description: timeout and interval API
layout: doc
menu:
@@ -35,12 +35,16 @@ print(t.running) // true
- `TIMEOUT`: Constant for a timeout timer type
## Functions
-### create(type, time, callback) -> Timer
+### hilbish.timers.create(type, time, callback) -> Timer
Creates a timer that runs based on the specified `time` in milliseconds.
The `type` can either be `hilbish.timers.INTERVAL` or `hilbish.timers.TIMEOUT`
+#### Parameters
+This function has no parameters.
-### get(id) -> Timer
+### hilbish.timers.get(id) -> Timer
Retrieves a timer via its ID.
+#### Parameters
+This function has no parameters.
## Types
## Timer
diff --git a/docs/api/hilbish/hilbish.userDir.md b/docs/api/hilbish/hilbish.userDir.md
index 0b95057..0c1d7d0 100644
--- a/docs/api/hilbish/hilbish.userDir.md
+++ b/docs/api/hilbish/hilbish.userDir.md
@@ -1,5 +1,5 @@
---
-title: Interface hilbish.userDir
+title: Module hilbish.userDir
description: user-related directories
layout: doc
menu:
diff --git a/docs/api/terminal.md b/docs/api/terminal.md
index 99d4b49..5ad24c7 100644
--- a/docs/api/terminal.md
+++ b/docs/api/terminal.md
@@ -11,16 +11,24 @@ menu:
The terminal library is a simple and lower level library for certain terminal interactions.
## Functions
-### restoreState()
+### terminal.restoreState()
Restores the last saved state of the terminal
+#### Parameters
+This function has no parameters.
-### saveState()
+### terminal.saveState()
Saves the current state of the terminal
+#### Parameters
+This function has no parameters.
-### setRaw()
+### terminal.setRaw()
Puts the terminal in raw mode
+#### Parameters
+This function has no parameters.
-### size()
+### terminal.size()
Gets the dimensions of the terminal. Returns a table with `width` and `height`
Note: this is not the size in relation to the dimensions of the display
+#### Parameters
+This function has no parameters.
diff --git a/golibs/bait/bait.go b/golibs/bait/bait.go
index 3f3c34e..4ba2a37 100644
--- a/golibs/bait/bait.go
+++ b/golibs/bait/bait.go
@@ -229,6 +229,8 @@ func handleHook(t *rt.Thread, c *rt.GoCont, name string, catcher *rt.Closure, ar
}
// throw(name, ...args)
+// #param name string The name of the hook.
+// #param args ...any The arguments to pass to the hook.
// Throws a hook with `name` with the provided `args`
// --- @param name string
// --- @vararg any