api_add_calling_info_to_procdoc |
|
Add the calling information (what are the functions called by this
proc_name) to the collected proc_doc information. |
api_add_to_proc_doc |
|
Add a certain value to a property in the proc doc of the specified proc. |
api_apropos_functions |
|
|
api_call_graph_snippet |
|
Return a source code for dot showing a local call graph snippet,
showing direct callers and directly called functions |
api_called_proc_names |
|
Return list of procs called by the specified procname handle. |
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_doc_url |
|
Return the procdoc url from procname and optionally from source_p and version_id |
api_proc_documentation |
|
Generates formatted documentation for a procedure. |
api_proc_format_switch |
|
|
api_proc_link |
|
|
api_proc_pretty_name |
|
|
api_proc_pretty_param_details |
|
|
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_test_case_url |
|
Return the testcase url from testcase_pair, consisting of
testcase_id and package_key. |
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::ad_keywords_score |
|
|
apidoc::ad_sort_by_first_string_proc |
|
basically a -1,0,1 result comparing the second element of the
list inputs then the first. |
apidoc::ad_sort_by_score_proc |
|
basically a -1,0,1 result comparing the second element of the
list inputs then the first. |
apidoc::ad_sort_by_second_string_proc |
|
basically a -1,0,1 result comparing the second element of the
list inputs then the first (both strings) |
apidoc::first_sentence |
|
|
apidoc::format_author |
|
Extracts information about the author and formats it into an
HTML string. |
apidoc::format_author_list |
|
Generates an HTML-formatted list of authors
(including <code><dt></code> and
<code><dd></code> tags). |
apidoc::format_changelog_change |
|
Formats the change log line: turns email addresses in parenthesis into links. |
apidoc::format_changelog_list |
|
Format the change log info |
apidoc::format_common_elements |
|
|
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::format_see_list |
|
Generate an HTML list of referenced procs and pages. |
apidoc::get_doc_property |
|
Return a certain doc property value, if property exists |
apidoc::get_doc_url |
|
|
apidoc::get_object_property |
|
Return poperties of objects agnostic to the object system
(i.e., XOTcl or NX). |
apidoc::get_xql_snippet |
|
|
apidoc::is_object |
|
Checks, whether the specified argument is an XOTcl object. |
apidoc::length_braces |
|
|
apidoc::length_exp |
|
|
apidoc::length_proc |
|
|
apidoc::length_regexp |
|
Calculate how much text we should ignore. |
apidoc::length_spaces |
|
|
apidoc::length_string |
|
|
apidoc::length_var |
|
|
apidoc::pretty_token |
|
Encode the specified token in HTML |
apidoc::sanitize_path |
|
Return a sanitized path. |
apidoc::search_on_webindex |
|
Search for a matching link in the page and return the absolute
link if found. |
apidoc::set_public |
|
Gets or sets the user's public/private preferences for a given
package. |
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. |
apidoc::xql_links_list |
|
|