api_describe_function (public)

 api_describe_function [ -format format ] proc

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

Describes the functions in the system that contain string and that have been defined using ad_proc. The description includes the documentation string, if any.

Switches:

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

Parameters:

proc (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:

acs_api_browser_api_describe_function

Source code:

    set matches [list]
    foreach function [nsv_array names api_proc_doc] {
        if {[string match -nocase $proc $function]} {
            array set doc_elements [nsv_get api_proc_doc $function]
            switch $format {
                text/plain {
                    lappend matches [ad_html_to_text -- [api_proc_documentation -script $function]]
                }
                default {
                    lappend matches [api_proc_documentation -script $function]
                }
            }
        }
    }
    switch $format {
        text/plain {
            set matches [join $matches "\n"]
        }
        default {
            set matches [join $matches "\n<p>\n"]
        }
    }
    return $matches

XQL Not present:

Generic, PostgreSQL, Oracle