document

Document a user-defined command, for access by help.

document [COMMANDNAME]

  • COMMANDNAME – The name of the command to document.

Documentation can only be created for existing user commands.

The COMMANDNAME should first be defined through the usage of the “define” command.

The “document” command reads lines of documentation just as “define” reads the lines of the command definition, ending with a single “end” line.

After the “document” command is finished, “help COMMANDNAME” displays the documentation you have written.