doc::package_info (private, deprecated)

 doc::package_info package_name info_ref

Defined in packages/acs-content-repository/tcl/doc-procs.tcl

Deprecated. Invoking this procedure generates a warning.

Set up a data source with overall package info (overview, see also, etc.)

Parameters:

package_name (required)

info_ref (required)

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

Testcases:

No testcase defined.

Source code:

ad_log_deprecated proc doc::package_info
        
        upvar $info_ref info
        
        set info_source [db_string get_info ""]
        
# Delete leading stars and dashes
        regsub -all -line -- {^( |--|\*|/\*\*|\*/)*} $info_source "" info_source
        
# Get the comment block
        regexp {[^@]*} $info_source comment
        set info(comment) $comment
        
        if {[regexp {@see (.*)} $info_source x see]} {
            foreach s [split $see ","] {
                # strip braces
                regsub {\{([^\}]+)\}} $s {\1} s
                lappend see_links $s
            }
        }
        if { [info exists see_links] } {
            set info(see) $see_links
        }

XQL Not present:

Generic

PostgreSQL XQL file:

<fullquery name="doc::package_info.get_info">
    <querytext>

        select doc__get_package_header(:package_name) from dual

      </querytext>
</fullquery>

packages/acs-content-repository/tcl/doc-procs-postgresql.xql

Oracle XQL file:

<fullquery name="doc::package_info.get_info">
    <querytext>

        select doc.get_package_header(:package_name) from dual

      </querytext>
</fullquery>

<fullquery name="doc::package_info.get_header">
    <querytext>

        select doc.get_proc_header(:proc_name, :package_name) from dual
      
      </querytext>
</fullquery>

packages/acs-content-repository/tcl/doc-procs-oracle.xql