apidoc::get_doc_url (private)

 apidoc::get_doc_url [ -cmd cmd ] [ -index index ] [ -root root ] \
    [ -host host ]

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

Switches:

-cmd

(optional)

-index

(optional)

-root

(optional)

-host

(optional)

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

Testcases:

No testcase defined.

Source code:

        foreach i $index r $root {
            set result [util_memoize [list ::util::http::get -url $i]]
            set page   [dict get $result page]

            #
            # Since man pages contain often a summary of multiple commands, try
            # abbreviation in case the full name is not found (e.g. man page "nsv"
            # contains "nsv_array", "nsv_set" etc.)
            #
            set url ""
            for {set i [string length $cmd]} {$i > 1} {incr i -1} {
                set proc [string range $cmd 0 $i]
                set url [apidoc::search_on_webindex  -page $page  -root $r  -host $host  -proc $proc]
                if {$url ne ""} {
                    ns_log notice "=== cmd <$cmd> --> $url"
                    return $url
                }
            }
        }
        ns_log notice "=== cmd <$cmd> not found on <$index> root <$root> host <$host>"
        return ""

XQL Not present:

Generic, PostgreSQL, Oracle