acs::tcllib::document (private)

 acs::tcllib::document package proc_name arguments documentation \
    [ protection ]

Defined in packages/acs-tcl/tcl/tcllib-doc-procs.tcl

Register documentation for an existing command of an already-loaded Tcllib package, without replacing its implementation or existing docs.

Parameters:

package (required)

Owning Tcllib package.

proc_name (required)

Fully qualified command name.

arguments (required)

Documented Tcl argument list.

documentation (required)

API-browser documentation text.

protection (optional, defaults to "public")

API-browser visibility, public or private.

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

Testcases:

No testcase defined.

Source code:

        if {[package provide $package] eq ""
            || [namespace which -command $proc_name] eq ""} {return}
        set name [string trimleft $proc_name :]
        set previous {}
        if {[nsv_exists api_proc_doc $name]} {
            set previous [nsv_get api_proc_doc $name]
            if {[dict exists $previous main]} {return}
        }
        d_proc -$protection $proc_name $arguments $documentation -
        # Complete any partial entry without losing testcase/caller links.
        nsv_set api_proc_doc $name [dict merge $previous [nsv_get api_proc_doc $name]]
        set script [dict get [nsv_get api_proc_doc $name] script]
        if {![nsv_exists api_proc_doc_scripts $script]
            || $name ni [nsv_get api_proc_doc_scripts $script]} {
            nsv_lappend api_proc_doc_scripts $script $name
        }

XQL Not present:

Generic, PostgreSQL, Oracle