api_proc_documentation (public)

api_proc_documentation [ -format format ] [ -script ] [ -source ] \
    proc_name

Defined in packages/acs-core/api-documentation-procs.tcl

Generates formatted documentation for a procedure.

Switches:

-format (defaults to "text/html") - the type of documentation to generate. Currently, only text/html is supported.
-script (boolean) - include information about what script this proc lives in?
-source (boolean) - include the source code for the script?

Parameters:

proc_name - the name of the procedure for which to generate documentation.

Returns:

the formatted documentation string.

Error:

if the procedure is not defined.