doc::sort_see (private)

 doc::sort_see list_ref directive_comments

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

procedure to deal with @see comments

Parameters:

list_ref (required)

directive_comments (required)

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

Testcases:

No testcase defined.

Source code:

    upvar $list_ref see_list

    lassign $directive_comments type see_name url

    if {$url eq "" } {
        switch -exact $type {

            namespace {
                set url "[doc::util::dbl_colon_fix $see_name].html"
            }

            proc {
                set split_name $see_name
                doc::util::text_divider split_name ::
                set name_length [llength $split_name]
                set see_namespace [join [lrange $split_name 0 $name_length-2] ""]
                set url "[doc::util::dbl_colon_fix $see_namespace].html#[set see_name]"
            }
        }
    }

    lappend see_list [list name "$see_name"  type "$type"  url "$url" ]
    set see_list [lsort -command doc::util::sort_see $see_list]

XQL Not present:

Generic, PostgreSQL, Oracle