apidoc::format_common_elements (private)

 apidoc::format_common_elements doc_elements_var

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

Parameters:
doc_elements_var

Partial Call Graph (max 5 caller/called nodes):
%3 api_proc_documentation api_proc_documentation (public) apidoc::format_common_elements apidoc::format_common_elements api_proc_documentation->apidoc::format_common_elements api_script_documentation api_script_documentation (public) api_script_documentation->apidoc::format_common_elements api_type_documentation api_type_documentation (public, deprecated) api_type_documentation->apidoc::format_common_elements apidoc::format_author_list apidoc::format_author_list (private) apidoc::format_common_elements->apidoc::format_author_list apidoc::format_changelog_list apidoc::format_changelog_list (private) apidoc::format_common_elements->apidoc::format_changelog_list apidoc::format_see_list apidoc::format_see_list (private) apidoc::format_common_elements->apidoc::format_see_list

Testcases:
No testcase defined.
Source code:
        upvar $doc_elements_var doc_elements

        set out ""

        if { [info exists doc_elements(author)] } {
            append out [format_author_list $doc_elements(author)]
        }
        if { [info exists doc_elements(creation-date)] } {
            append out "<dt>Created:</dt>\n<dd>[lindex $doc_elements(creation-date) 0]</dd>\n"
        }
        if { [info exists doc_elements(change-log)] } {
            append out [format_changelog_list $doc_elements(change-log)]
        }
        if { [info exists doc_elements(cvs-id)] } {
            append out "<dt>CVS ID:</dt>\n<dd><code>[ns_quotehtml [lindex $doc_elements(cvs-id) 0]]</code></dd>\n"
        }
        if { [info exists doc_elements(see)] } {
            append out [format_see_list $doc_elements(see)]
        }

        return $out
XQL Not present:
Generic, PostgreSQL, Oracle
[ hide source ] | [ make this the default ]
Show another procedure: