doc::func_list (private, deprecated)

 doc::func_list package_name [ db ]

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

Deprecated. Invoking this procedure generates a warning.

Return a list of all the function creation headers in a package, in form { value value ... }

Parameters:

package_name (required)

db (optional)

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

Testcases:

No testcase defined.

Source code:

ad_log_deprecated proc doc::func_list

      set result [db_list_of_lists get_funcs ""]

    set line_opts [list]
    foreach line $result {
      # Only get lines in form "procedure proc_name..." or "function func_name..."
      if { [regexp {(procedure|function)[^a-zA-Z0-9_]*([a-zA-Z0-9_]+)} $line match type name] && 
       ![regexp {\-\-} $line match]} {
        lappend line_opts [list "[string totitle $type] [string tolower $name]"  [string tolower $name]]
      }
    }
 
    return $line_opts

XQL Not present:

Generic

PostgreSQL XQL file:

<fullquery name="doc::func_list.get_funcs">
    <querytext>

        select 
          'function ' || proname as line_header
        from 
          pg_proc 
        where 
          proname like lower(:package_name) || '\\\_\\\_%' 
        order by 
          line_header
    
      </querytext>
</fullquery>

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

Oracle XQL file:

<fullquery name="doc::func_list.get_funcs">
    <querytext>

       select distinct 
        lower(text) as line_header 
      from 
        user_source
      where 
        type='PACKAGE'
      and
        lower(name) = lower(:package_name)
      and (
          lower(text) like '%procedure%'
        or
          lower(text) like '%function%'
      )
      order by line_header
    
      </querytext>
</fullquery>

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