api_read_script_documentation (public)

 api_read_script_documentation path

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

Reads the contract from a Tcl content page.

Parameters:

path (required)

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

Returns:

a list representation of the documentation element array, or an empty list if the file does not contain a doc_page_contract block.

Error:

if the file does not exist.

Testcases:

acs_api_browser_api_read_script_documentation