diff --git a/api.go b/api.go index 3e5f892..b4f2d1d 100644 --- a/api.go +++ b/api.go @@ -1,6 +1,6 @@ -// Here is the core api for the hilbi shell itself -// Basically, stuff about the shell itself and other functions -// go here. +// the core Hilbish API +// The Hilbish module includes the core API, containing +// interfaces and functions which directly relate to shell functionality. package main import ( diff --git a/cmd/docgen/docgen.go b/cmd/docgen/docgen.go index b633a89..b39b016 100644 --- a/cmd/docgen/docgen.go +++ b/cmd/docgen/docgen.go @@ -116,6 +116,7 @@ func main() { } for _, t := range p.Types { for _, m := range t.Methods { + if !strings.HasPrefix(t.Name, "hl") && l == "main" { continue } if !strings.HasPrefix(m.Name, prefix[l]) || m.Name == "Loader" { continue } parts := strings.Split(strings.TrimSpace(m.Doc), "\n") funcsig := parts[0] diff --git a/docs/api/hilbish.md b/docs/api/hilbish.md index 61c3637..96746ae 100644 --- a/docs/api/hilbish.md +++ b/docs/api/hilbish.md @@ -1,12 +1,12 @@ --- name: Module hilbish -description: Here is the core api for the hilbi shell itself +description: the core Hilbish API layout: apidoc --- ## Introduction -Basically, stuff about the shell itself and other functions -go here. +The Hilbish module includes the core API, containing +interfaces and functions which directly relate to shell functionality. ## Functions ### alias(cmd, orig) @@ -89,113 +89,3 @@ Returns a `timer` object (see `doc timers`). ### which(name) Checks if `name` is a valid command -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### - -### -