doc::get_proc_header (private, deprecated)

 doc::get_proc_header proc_name package_name doc_ref code_ref [ db ]

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

Deprecated. Invoking this procedure generates a warning.

Retrieve the function header for a specific function and parse out the javadoc comment.

Parameters:

proc_name (required)

package_name (required)

doc_ref (required)

code_ref (required)

db (optional)

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

Testcases:

No testcase defined.

Source code:

ad_log_deprecated proc doc::get_proc_header

    variable start_text;
    variable end_text;

    upvar $doc_ref  doc
    upvar $code_ref code

    set header [db_string get_header ""]

    # Get JavaDoc block, if any
    if { [regexp {/\*\*(.*)\*/} $header match] } {
      # Strip off the leading --, *, /**, */
      regsub -all -line -- {^( |--|\*|/\*\*|\*/)*} $match "" doc
      # Take the doc out of the code
      regsub  -- { *--/\*\*.*\*/(\n*)} $header "" code
    } else {
      set doc ""
      set code $header
    }

XQL Not present:

Generic

PostgreSQL XQL file:

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

        select doc__get_proc_header(:proc_name, :package_name) from dual
      
      </querytext>
</fullquery>

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

Oracle XQL file:

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