doc::parse_tcl_library (private)

 doc::parse_tcl_library dir_list

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

takes the absolute path of the Tcl library directory and parses through it

Parameters:

dir_list (required)

Returns:

a long lists of lists of lists, each list element contains a three-element list of the format - { {info} {public procedures listing } {private procedures listing}}

See Also:

• doc::parse_file
• template::util::comment_text_normalize

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

Testcases:

No testcase defined.

Source code:

    # namespace_list will be a list containing namespace names only, and should be ordered
    # with respect to namespaces in the same order as the list result

    upvar namespace_list namespace_list
    set namespace_list [list]

    set result [list]

    foreach dir $dir_list {

        #debug
        #template::util::display_value dir

        # using this lame hack since most aD servers are running an earlier version of Tcl than 8.3,
        # which supports the -directory switch that this hack emulates
        append file_list [glob -nocomplain $dir/*.tcl $dir/*/*.tcl $dir/*/*/*.tcl $dir/*/*/*/*.tcl ]
        append file_list " "
    }

    #debugging
    #template::util::display_value file_list

    foreach tcl_file $file_list {
        ns_log notice "doc::parse_tcl_library: parsing through $tcl_file for documentation"

        set comments_parsed_p [doc::parse_file $tcl_file]
        if {! $comments_parsed_p } {
            ns_log notice "doc::parse_tcl_library: no @namespace directives found in $tcl_file"
        }
    }
    return $result

XQL Not present:

Generic, PostgreSQL, Oracle