api_add_to_proc_doc |
|
Add a certain value to a property in the proc doc of the specified proc. |
api_apropos_functions |
|
|
api_describe_function |
|
Describes the functions in the system that contain string and that
have been defined using ad_proc. |
api_get_body |
|
This function returns the body of a Tcl proc or an XOTcl method. |
api_library_documentation |
|
Generates formatted documentation for a Tcl library file (just the header,
describing what the library does). |
api_proc_documentation |
|
Generates formatted documentation for a procedure. |
api_proc_link |
|
|
api_proc_pretty_name |
|
|
api_proc_url |
|
|
api_read_script_documentation |
|
Reads the contract from a Tcl content page. |
api_script_documentation |
|
Generates formatted documentation for a content page. |
api_type_documentation |
|
Deprecated: this was part of a feature which used to react to the
'type' property set in ad_page_contract's documentation and
generate an extra link in /api-doc/package-view, but currently no
upstream script seems to specify this value and no code seems to
create necessary 'doc_type_doc' nsv |
apidoc::format_author |
|
Extracts information about the author and formats it into an
HTML string. |
apidoc::format_see |
|
Takes the value in the argument "see" and possibly formats it
into a link that will give the user more info about that
resource |
apidoc::get_object_property |
|
Return poperties of objects agnostic to the object system
(i.e., XOTcl or NX). |
apidoc::tcl_to_html |
|
Given a proc name, formats it as HTML, including highlighting syntax in
various colors and creating hyperlinks to other proc definitions. |
apidoc::tclcode_to_html |
|
Given a script, this proc formats it as HTML, including highlighting syntax in
various colors and creating hyperlinks to other proc definitions. |