ad_page_contract { Display information about one procedure. @cvs-id $Id: proc-view.tcl,v 1.6.16.1 2013/08/27 12:20:34 gustafn Exp $ } { proc source_p:optional,integer,trim {version_id ""} } -properties { title:onevalue context:onevalue source_p:onevalue default_source_p:onevalue return_url:onevalue documentation:onevalue error_msg:onevalue } set title $proc set context [list] if { [exists_and_not_null version_id] } { db_1row package_info_from_package_id { select pretty_name, package_key, version_name from apm_package_version_info where version_id = :version_id } lappend context [list "package-view?version_id=$version_id&kind=procs" "$pretty_name $version_name"] } lappend context [list $proc] set default_source_p [ad_get_client_property -default 0 acs-api-browser api_doc_source_p] set return_url [ns_urlencode [ad_conn url]?[export_url_vars proc version_id]] set error_msg "" if { ![info exists source_p] } { set source_p $default_source_p } # Try and be helpful about the procedure. if { ![nsv_exists api_proc_doc $proc] } { if {[info procs ::$proc] ne ""} { set error_msg "
This procedure is defined in the server but not documented via ad_proc or proc_doc and may be intended as a private interface.
The procedure is defined as:
proc $proc {[info args $proc]} { [ad_quotehtml [info body $proc]] }" } elseif {[info commands ::$proc] ne ""} { set error_msg "
The procedure $proc is an available command on the server and might be found in the TCL or AOLServer documentation or in documentation for a loadable module (like ns_cache for example).
" } else { set error_msg "The procedure $proc is not defined in the server.
" } } else { if { $source_p } { set documentation [api_proc_documentation -script -xql -source $proc] } else { set documentation [api_proc_documentation -script $proc] } }