api_script_documentation (public)

 api_script_documentation [ -format format ] path

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

Generates formatted documentation for a content page. Sources the file to obtain the comment or contract at the beginning.

Switches:

-format (optional, defaults to "text/html")

the type of documentation to generate. Currently, only text/html is supported.

Parameters:

path (required)

the path of the Tcl file to examine, relative to the OpenACS root directory.

Returns:

the formatted documentation string.

Error:

if the file does not exist.

Testcases:

acs_api_browser_api_script_documentation