lib/doc.lua

doc.searchers.lib(name^string^): string, string

Tries to find a documentation from a library with name. Returns either a string of documentation, or false and a reason.

doc.docs(topic^string^): boolean

Displays the documentation for topic, returning true, or errors. Also callable as just doc().

doc.format(fdoc^table^): string

returns VT100 formatted documentation from documentation table fdoc

doc.searchers.cdoc(topic^string^): string, string

Searches for documentation labelled as topic in .dict files under /boot/doc/

doc.parsefile(path^string^): table

parses file from path to return a documentation table

© ShadowKat Studios
The software used to generate this page is licensed under the Mozilla Public License version 2 and can be found here