api_proc_documentation (public)

 api_proc_documentation [ -format format ] [ -script ] [ -source ] \
    [ -xql ] [ -label label ] [ -first_line_tag first_line_tag ] \
    [ -proc_type proc_type ] proc_name

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

Generates formatted documentation for a procedure.

Switches:

-format (optional)

the type of documentation to generate. This parameter is deprecated and has no effect.

-script (optional, boolean)

include information about what script this proc lives in?

-source (optional, boolean)

include the source code for the script?

-xql (optional, boolean)

include the source code for the related xql files?

-label (optional)

the label printed for the proc in the header line

-first_line_tag (optional, defaults to "<h3>")

tag for the markup of the first line

-proc_type (optional)

Parameters:

proc_name (required)

the name of the procedure for which to generate documentation.

Returns:

the formatted documentation string.

Error:

if the procedure is not defined.

Testcases:

acs_api_browser_api_proc_documentation