doc::get_proc_doc (private, deprecated)

 doc::get_proc_doc proc_name package_name param_ref tags_ref code_ref \
    [ args... ]

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

Deprecated. Invoking this procedure generates a warning.

Query the database and prepare the datasources The user should call this procedure

Parameters:

proc_name (required)

package_name (required)

param_ref (required)

tags_ref (required)

code_ref (required)

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

Testcases:

No testcase defined.

Source code:

ad_log_deprecated proc doc::get_proc_doc
 
    upvar $tags_ref tags

    set opts(db) ""
    template::util::get_opts $args

    get_proc_header $proc_name $package_name doc_block code_block $opts(db)
    parse_proc_header $doc_block $code_block $param_ref $tags_ref $code_ref

    # Get the proc name
    if { ![info exists tags(name)] } {
      set tags(name) "${package_name}.${proc_name}"
    }

    # Modify the "see" tag to dislplay links
    if { [info exists tags(see)] } {
      if { ![info exists opts(link_url_stub)] } {
        # Just remove the links
        regsub -all -- {\{([^\}]*)\}} $tags(see) {\1} new_see
        set tags(see) $new_see
      } else {
        if { ![info exists opts(link_package_name)] } {
          set opts(link_package_name) package_name
    }
        if { ![info exists opts(link_proc_name)] } {
          set opts(link_proc_name) proc_name
    }
       
        regsub -all -- {\&} $opts(link_url_stub) {\\\&} stub
        set subspec "<a href=\"${stub}${opts(link_package_name)}=\\1\\&$opts(link_proc_name)=\\2\">\\1.\\2</a>"
        regsub -all -- {\{([a-zA-Z0-9_]+)\.([a-zA-Z0-9_]+)\}} $tags(see) $subspec new_see
        set tags(see) $new_see
      }        
    }

XQL Not present:

Generic

PostgreSQL XQL file:

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

Oracle XQL file:

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