Index: openacs-4/packages/acs-content-repository/tcl/doc-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-content-repository/tcl/doc-procs.tcl,v diff -u -N -r1.5 -r1.6 --- openacs-4/packages/acs-content-repository/tcl/doc-procs.tcl 13 Aug 2002 04:21:33 -0000 1.5 +++ openacs-4/packages/acs-content-repository/tcl/doc-procs.tcl 27 Jul 2006 01:15:52 -0000 1.6 @@ -6,8 +6,11 @@ namespace eval doc { -# Set up a data source with overall package info (overview, see also, etc.) + ad_proc -public package_info { package_name info_ref } { + Set up a data source with overall package info + (overview, see also, etc.) + } { upvar $info_ref info @@ -32,10 +35,12 @@ } } - # Retreive the function header for a specific function - # and parse out the javadoc comment - ad_proc -public get_proc_header { proc_name package_name doc_ref code_ref { db "" } } { + ad_proc -public get_proc_header { proc_name package_name doc_ref code_ref { db "" } } { + Retreive the function header for a specific function + and parse out the javadoc comment. + } { + variable start_text; variable end_text; @@ -56,11 +61,12 @@ } } - # Parse the header block and prepare the datasources: - # Prepare a multirow datasource for the param tags - # Prepare a onerow datasource for all the other tags - ad_proc -public parse_proc_header { doc_block code_block param_ref tags_ref code_ref {level 2}} { + ad_proc -public parse_proc_header { doc_block code_block param_ref tags_ref code_ref {level 2}} { + Parse the header block and prepare the datasources: + Prepare a multirow datasource for the param tags + Prepare a onerow datasource for all the other tags + } { upvar $level "${param_ref}:rowcount" param_rowcount upvar $level $tags_ref tags @@ -104,9 +110,11 @@ set code $code_block } - # Query the database and prepare the datasources - # The user should call this procedure - ad_proc -public get_proc_doc { proc_name package_name param_ref tags_ref code_ref args } { + + ad_proc -public get_proc_doc { proc_name package_name param_ref tags_ref code_ref args } { + Query the database and prepare the datasources + The user should call this procedure + } { upvar $tags_ref tags @@ -144,18 +152,19 @@ } - # Return a list of all the packages in the data model, in form - # { {label value} {label value} ... } - ad_proc -public package_list { {db ""} } { + ad_proc -public package_list { {db ""} } { + Return a list of all the packages in the data model, in form + { {label value} {label value} ... } + } { - set result [db_list_of_list get_packages ""] - - return $result - } + set result [db_list_of_list get_packages ""] + + return $result + } - # Return a list of all the function creation headers in a package, in form - # { value value ... } - ad_proc -public func_list { package_name {db ""} } { + ad_proc -public func_list { package_name {db ""} } { + Return a list of all the function creation headers in a package, in form { value value ... } + } { set result [db_list_of_lists get_funcs ""] @@ -172,10 +181,12 @@ return $line_opts } - # Return a multirow datatsource for all the functions - # { value value ... } - ad_proc -public func_multirow { package_name result_ref {db ""} } { + ad_proc -public func_multirow { package_name result_ref {db ""} } { + Return a multirow datatsource for all the functions + { value value ... } + } { + upvar "${result_ref}:rowcount" result_rowcount set result_rowcount 0