Index: openacs-4/packages/acs-api-browser/www/type-view.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-api-browser/www/Attic/type-view.tcl,v diff -u -r1.2 -r1.2.8.1 --- openacs-4/packages/acs-api-browser/www/type-view.tcl 6 Sep 2002 21:49:54 -0000 1.2 +++ openacs-4/packages/acs-api-browser/www/type-view.tcl 15 Dec 2003 15:49:56 -0000 1.2.8.1 @@ -22,12 +22,10 @@ } } -if [exists_and_not_null version_id] { - set public_p [api_set_public $version_id] -} else { - set public_p [api_set_public] -} +set public_p [api_set_public $version_id] + + set context [list] if { [info exists version_id] } { Index: openacs-4/packages/acs-automated-testing/tcl/aa-test-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-automated-testing/tcl/aa-test-procs.tcl,v diff -u -r1.20.2.1 -r1.20.2.2 --- openacs-4/packages/acs-automated-testing/tcl/aa-test-procs.tcl 9 Dec 2003 12:26:45 -0000 1.20.2.1 +++ openacs-4/packages/acs-automated-testing/tcl/aa-test-procs.tcl 15 Dec 2003 15:49:56 -0000 1.20.2.2 @@ -84,7 +84,7 @@ } } -ad_proc aa_unstub { +ad_proc -public aa_unstub { proc_name } { @author Peter Harper @@ -237,7 +237,7 @@ } # set munged_body [subst {uplevel 1 {$body}}] - ad_proc _${package_key}__c_$component_id {} $body + ad_proc -private _${package_key}__c_$component_id {} $body } ad_proc -public aa_call_component { @@ -394,7 +394,7 @@ } " } - ad_proc _${package_key}__$testcase_id {} " + ad_proc -private _${package_key}__$testcase_id {} " $init_class_code set _aa_export {} set body_count 0 @@ -425,16 +425,18 @@ " } -ad_proc aa_runseries { +ad_proc -public aa_runseries { -quiet:boolean {-testcase_id ""} by_package_key by_category } { - Runs a series of testcases.

+ Runs a series of testcases. + Runs all cases if both package_key and category are blank, otherwise it uses the package and/or category to select which testcases to run. + @author Peter Harper @creation-date 24 July 2001 } { @@ -513,7 +515,7 @@ } -ad_proc aa_run_testcase { +ad_proc -public aa_run_testcase { testcase_id } { @author Peter Harper @@ -698,7 +700,7 @@ aa_log_result "fail" $error_notes } -ad_proc aa_log_result { +ad_proc -public aa_log_result { test_result test_notes } { @@ -748,7 +750,7 @@ db_dml test_result_insert {} } -ad_proc aa_log_final { +ad_proc -public aa_log_final { test_passes test_fails } { @@ -772,7 +774,7 @@ } } -ad_proc aa_run_with_teardown { +ad_proc -public aa_run_with_teardown { {-test_code:required} {-teardown_code ""} -rollback:boolean Index: openacs-4/packages/acs-automated-testing/tcl/example-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-automated-testing/tcl/example-procs.tcl,v diff -u -r1.2 -r1.2.2.1 --- openacs-4/packages/acs-automated-testing/tcl/example-procs.tcl 1 Nov 2003 08:45:36 -0000 1.2 +++ openacs-4/packages/acs-automated-testing/tcl/example-procs.tcl 15 Dec 2003 15:49:56 -0000 1.2.2.1 @@ -15,7 +15,7 @@ @cvs-id $Id$ } -ad_proc aa_example_write_audit_entry { +ad_proc -public aa_example_write_audit_entry { name value } { @@ -26,7 +26,7 @@ return 1 } -ad_proc aa_example_write_audit_entries { +ad_proc -public aa_example_write_audit_entries { entries } { @author Peter Harper Index: openacs-4/packages/acs-bootstrap-installer/tcl/00-proc-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-bootstrap-installer/tcl/00-proc-procs.tcl,v diff -u -r1.16 -r1.16.2.1 --- openacs-4/packages/acs-bootstrap-installer/tcl/00-proc-procs.tcl 29 Oct 2003 10:12:41 -0000 1.16 +++ openacs-4/packages/acs-bootstrap-installer/tcl/00-proc-procs.tcl 15 Dec 2003 15:49:56 -0000 1.16.2.1 @@ -393,7 +393,8 @@ ad_proc -public -deprecated proc_doc { args } { A synonym for ad_proc (to support legacy code). - + + @see ad_proc } { eval ad_proc $args } @@ -409,7 +410,7 @@ } {

Declare a procedure with the following enhancements - over regular Tcl "proc": + over regular Tcl "proc":

@@ -464,7 +465,7 @@

Here's an example with named parameters, and namespaces (notice the preferred way of - declaring namespaces and namespaced procedures). Ignore the "\" in "\@param", + declaring namespaces and namespaced procedures). Ignore the \ in "\@param", I had to use it so the api-browser wouldn't think the parameter docs were for ad_proc itself:

@@ -602,7 +603,7 @@ } - # procedures for doing type based dispatch -ad_proc ad_method { +ad_proc -proc ad_method { method_name type argblock @@ -623,7 +624,7 @@ ad_proc ${method_name}__$type $argblock $docblock $body } -ad_proc ad_call_method { +ad_proc -public ad_call_method { method_name object_id args @@ -641,7 +642,7 @@ return [apply ${method_name}__[util_memoize "acs_object_type $object_id"] [concat $object_id $args]] } -ad_proc ad_dispatch { +ad_proc -public ad_dispatch { method_name type args Index: openacs-4/packages/acs-bootstrap-installer/tcl/30-apm-load-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-bootstrap-installer/tcl/30-apm-load-procs.tcl,v diff -u -r1.30 -r1.30.2.1 --- openacs-4/packages/acs-bootstrap-installer/tcl/30-apm-load-procs.tcl 10 Oct 2003 14:05:36 -0000 1.30 +++ openacs-4/packages/acs-bootstrap-installer/tcl/30-apm-load-procs.tcl 15 Dec 2003 15:49:56 -0000 1.30.2.1 @@ -26,7 +26,7 @@ return [info exists apm_first_time_loading_p] } -ad_proc ad_after_server_initialization { name args } { +ad_proc -public ad_after_server_initialization { name args } { Registers code to run after server initialization is complete. @@ -37,7 +37,7 @@ nsv_lappend ad_after_server_initialization . [list name $name script [info script] args $args] } -ad_proc apm_guess_file_type { package_key path } { +ad_proc -public apm_guess_file_type { package_key path } { Guesses and returns the file type key corresponding to a particular path (or an empty string if none is known). $path should be @@ -366,7 +366,7 @@ return [expr ![file exists "${package_path}/sql"] || [file exists "${package_path}/sql/[db_type]"]] } -ad_proc apm_source { __file } { +ad_proc -private apm_source { __file } { Sources $__file in a clean environment, returning 1 if successful or 0 if not. Records that the file has been sourced and stores its mtime in the nsv array apm_library_mtime @@ -390,15 +390,15 @@ # Special boot strap load file routine. -ad_proc apm_bootstrap_load_file { root_directory file } { +ad_proc -private apm_bootstrap_load_file { root_directory file } { Source a single file during initial bootstrapping and set APM data. } { ns_log "Notice" "Loading [file tail $root_directory]/$file" apm_source "${root_directory}/${file}" } -ad_proc apm_bootstrap_load_libraries { +ad_proc -private apm_bootstrap_load_libraries { {-load_tests:boolean 0} {-init:boolean} {-procs:boolean} Index: openacs-4/packages/acs-service-contract/tcl/acs-service-contract-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-service-contract/tcl/acs-service-contract-procs.tcl,v diff -u -r1.19.2.2 -r1.19.2.3 --- openacs-4/packages/acs-service-contract/tcl/acs-service-contract-procs.tcl 3 Dec 2003 22:19:05 -0000 1.19.2.2 +++ openacs-4/packages/acs-service-contract/tcl/acs-service-contract-procs.tcl 15 Dec 2003 15:49:56 -0000 1.19.2.3 @@ -229,7 +229,7 @@ -ad_proc -deprecated acs_sc_call { +ad_proc -private -deprecated acs_sc_call { {-error:boolean} contract operation @@ -245,6 +245,8 @@ @param error If specified, will throw an error if the operation isn't implemented. @author Neophytos Demetriou + + @see acs_sc::invoke } { set proc_name [acs_sc_generate_name $contract $impl $operation] Index: openacs-4/packages/acs-subsite/tcl/package-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-subsite/tcl/package-procs.tcl,v diff -u -r1.10 -r1.10.8.1 --- openacs-4/packages/acs-subsite/tcl/package-procs.tcl 10 Sep 2002 22:22:11 -0000 1.10 +++ openacs-4/packages/acs-subsite/tcl/package-procs.tcl 15 Dec 2003 15:49:56 -0000 1.10.8.1 @@ -6,7 +6,7 @@ @author mbryzek@arsdigita.com @creation-date Wed Dec 27 16:02:44 2000 - @cvs-id $Id$ + @cvs-id package-procs.tcl,v 1.10 2002/09/10 22:22:11 jeffd Exp } @@ -635,7 +635,8 @@ ad_proc -private package_plsql_args { { -function_name "NEW" } - object_type + { -package_name "" } + { object_type } } { Generates a list of parameters expected to a plsql function @@ -653,11 +654,14 @@ @param function_name The function name which we're looking up } { + + if { [empty_string_p $package_name] } { db_1row select_type_info { select t.package_name from acs_object_types t where t.object_type = :object_type } + } # Get just the args return [db_list select_object_type_param_list { @@ -846,7 +850,7 @@ #set real_params([string toupper [lindex $row 1]]) 1 #} - foreach arg [util_memoize "package_plsql_args \"$object_type\""] { + foreach arg [util_memoize [list package_plsql_args -package_name $package_name $object_type]] { set real_params([string toupper $arg]) 1 } Index: openacs-4/packages/acs-tcl/tcl/admin-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/admin-procs.tcl,v diff -u -r1.13.2.1 -r1.13.2.2 --- openacs-4/packages/acs-tcl/tcl/admin-procs.tcl 21 Nov 2003 22:09:22 -0000 1.13.2.1 +++ openacs-4/packages/acs-tcl/tcl/admin-procs.tcl 15 Dec 2003 15:49:56 -0000 1.13.2.2 @@ -10,11 +10,13 @@ ad_proc -deprecated -warn ad_ssl_available_p {} { Returns 1 if this AOLserver has the SSL module installed. + + @see security::https_available_p } { return [security::https_available_p] } -proc_doc ad_restrict_to_https {conn args why} { +ad_proc -public ad_restrict_to_https {conn args why} { Redirects user to HTTPS. @author Allen Pulsifer (pulsifer@mediaone.net) @@ -30,7 +32,7 @@ return "filter_return" } -proc_doc ad_approval_system_inuse_p {} { +ad_proc -public ad_approval_system_inuse_p {} { Returns 1 if the system is configured to use and approval system. } { if {[ad_parameter RegistrationRequiresEmailVerification] && [ad_parameter RegistrationRequiresApprovalP] } { @@ -40,13 +42,13 @@ } } -proc_doc ad_user_class_parameters {} { +ad_proc -private ad_user_class_parameters {} { Returns the list of parameter var names used to define a user class. } { return [list category_id country_code usps_abbrev intranet_user_p group_id last_name_starts_with email_starts_with expensive user_state sex age_above_years age_below_years registration_during_month registration_before_days registration_after_days registration_after_date last_login_before_days last_login_after_days last_login_equals_days number_visits_below number_visits_above user_class_id sql_post_select crm_state curriculum_elements_completed] } -proc_doc ad_user_class_description { set_id } { +ad_proc -private ad_user_class_description { set_id } { Takes an ns_set of key/value pairs and produces a human-readable description of the class of users specified. } { set clauses [list] @@ -175,7 +177,7 @@ return $pretty_description } -proc_doc ad_user_class_query { set_id } { +ad_proc -private ad_user_class_query { set_id } { Takes an ns_set of key/value pairs and produces a query for the class of users specified (one user per row returned). @param set_id The id of a ns_set containing all the parameters of the user class. @@ -408,15 +410,15 @@ } -proc_doc ad_user_class_query_count_only { set_id } { +ad_proc -private ad_user_class_query_count_only { set_id } { Takes an ns_set of key/value pairs and produces a query that will compute the number of users in the class specified. } { set new_set [ns_set copy $set_id] ns_set update $new_set count_only_p 1 return [ad_user_class_query $new_set] } -proc_doc ad_registration_finite_state_machine_admin_links { +ad_proc -private ad_registration_finite_state_machine_admin_links { member_state email_verified_p user_id Index: openacs-4/packages/acs-tcl/tcl/defs-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/defs-procs.tcl,v diff -u -r1.38 -r1.38.2.1 --- openacs-4/packages/acs-tcl/tcl/defs-procs.tcl 1 Nov 2003 09:23:39 -0000 1.38 +++ openacs-4/packages/acs-tcl/tcl/defs-procs.tcl 15 Dec 2003 15:49:56 -0000 1.38.2.1 @@ -211,7 +211,7 @@ return [acs_community_member_admin_link -user_id $user_id -label $name] } -ad_proc ad_header { +ad_proc -deprecated ad_header { {-focus ""} page_title {extra_stuff_for_document_head ""} @@ -227,7 +227,7 @@ } -ad_proc ad_header_with_extra_stuff { +ad_proc -deprecated ad_header_with_extra_stuff { {-focus ""} page_title {extra_stuff_for_document_head ""} @@ -266,7 +266,7 @@ return $html } -ad_proc ad_footer { +ad_proc -deprecated ad_footer { {signatory ""} {suppress_curriculum_bar_p 0} } { @@ -313,13 +313,13 @@ # the way a page works, they should see a link to the # email address of the programmer who can fix the page). -ad_proc ad_admin_owner {} { +ad_proc -public ad_admin_owner {} { @return E-mail address of the Administrator of this site. } { return [ad_parameter -package_id [ad_acs_kernel_id] AdminOwner] } -ad_proc ad_admin_header { +ad_proc -deprecated ad_admin_header { {-focus ""} page_title } "" { @@ -333,7 +333,7 @@ return [ad_header_with_extra_stuff -focus $focus $page_title] } -ad_proc ad_admin_footer {} { +ad_proc -deprecated ad_admin_footer {} { Signs pages with ad_admin_owner (usually a programmer who can fix bugs) rather than the signatory of the user pages } { @@ -349,7 +349,7 @@ " } -ad_proc ad_return_complaint { +ad_proc -public ad_return_complaint { exception_count exception_text } { Index: openacs-4/packages/acs-tcl/tcl/object-procs-oracle.xql =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/Attic/object-procs-oracle.xql,v diff -u -r1.3 -r1.3.2.1 --- openacs-4/packages/acs-tcl/tcl/object-procs-oracle.xql 21 Oct 2003 22:23:24 -0000 1.3 +++ openacs-4/packages/acs-tcl/tcl/object-procs-oracle.xql 15 Dec 2003 15:49:56 -0000 1.3.2.1 @@ -25,7 +25,7 @@ o.modifying_user, o.modifying_ip, o.tree_sortkey, - acs_object.name(o.object_id) + acs_object.name(o.object_id) as object_name from acs_objects o where o.object_id = :object_id Index: openacs-4/packages/acs-tcl/tcl/object-procs-postgresql.xql =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/Attic/object-procs-postgresql.xql,v diff -u -r1.3 -r1.3.2.1 --- openacs-4/packages/acs-tcl/tcl/object-procs-postgresql.xql 21 Oct 2003 22:23:24 -0000 1.3 +++ openacs-4/packages/acs-tcl/tcl/object-procs-postgresql.xql 15 Dec 2003 15:49:56 -0000 1.3.2.1 @@ -25,7 +25,7 @@ o.modifying_user, o.modifying_ip, o.tree_sortkey, - acs_object__name(o.object_id) + acs_object__name(o.object_id) as object_name from acs_objects o where o.object_id = :object_id Index: openacs-4/packages/acs-tcl/tcl/object-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/object-procs.tcl,v diff -u -r1.4 -r1.4.2.1 --- openacs-4/packages/acs-tcl/tcl/object-procs.tcl 21 Oct 2003 22:23:24 -0000 1.4 +++ openacs-4/packages/acs-tcl/tcl/object-procs.tcl 15 Dec 2003 15:49:56 -0000 1.4.2.1 @@ -11,37 +11,38 @@ namespace eval acs_object {} ad_proc -private acs_lookup_magic_object { name } { + Non memoized version of acs_magic_object. - Returns the object ID of a magic object (performing no memoization). + @return the magic object's object ID + @see acs_magic_object } { return [db_string magic_object_select { select object_id from acs_magic_objects where name = :name }] } -ad_proc acs_magic_object { name } { - +ad_proc -public acs_magic_object { name } { Returns the object ID of a magic object. @param name the name of the magic object (as listed in the acs_magic_objects table). @return the object ID. - @error if no object exists with that magic name. + @error if no object exists with that magic name. } { return [util_memoize [list acs_lookup_magic_object $name]] } -ad_proc acs_object_name { object_id } { +ad_proc -public acs_object_name { object_id } { Returns the name of an object. } { return [db_string object_name_get {}] } -ad_proc acs_object_type { object_id } { +ad_proc -public acs_object_type { object_id } { Returns the type of an object. @@ -53,25 +54,34 @@ } -default ""] } -ad_proc acs_object::get { +ad_proc -public acs_object::get { {-object_id:required} {-array:required} } { Gets information about an acs_object. - @array The name of an array in the caller's namespace where the info should be delivered. + Returns object_id, object_type, context_id, security_inherit_p, + creation_user, creation_date_ansi, creation_ip, last_modified_ansi, + modifying_user, modifying_ip, tree_sortkey, object_name + + @param array An array in the caller's namespace into which the info should be delivered (upvared) } { upvar 1 $array row db_1row select_object {} -column_array row } -ad_proc acs_object::get_element { +ad_proc -public acs_object::get_element { {-object_id:required} {-element:required} } { Gets a specific element from the info returned by acs_object::get. + @param object_id the object to get data for + @param element the field to return + + @return the value of the specified element + @see acs_object::get } { acs_object::get -object_id $object_id -array row Index: openacs-4/packages/acs-tcl/tcl/server-cluster-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/server-cluster-procs.tcl,v diff -u -r1.1.1.1 -r1.1.1.1.10.1 --- openacs-4/packages/acs-tcl/tcl/server-cluster-procs.tcl 13 Mar 2001 22:59:26 -0000 1.1.1.1 +++ openacs-4/packages/acs-tcl/tcl/server-cluster-procs.tcl 15 Dec 2003 15:49:56 -0000 1.1.1.1.10.1 @@ -58,11 +58,11 @@ } } -proc_doc server_cluster_logging_p {} { Returns true if we're logging cluster requests. } { +ad_proc -private server_cluster_logging_p {} { Returns true if we're logging cluster requests. } { return [ad_parameter -package_id [ad_acs_kernel_id] EnableLoggingP server-cluster 0] } -ad_proc server_cluster_httpget_from_peers { +ad_proc -private server_cluster_httpget_from_peers { { -timeout 5 } url } { Schedules an HTTP GET request to be issued immediately to all peer hosts (using ad_schedule_proc -once t -thread f -debug t 0). } { @@ -77,16 +77,17 @@ } } -proc_doc ad_canonical_server_p {} { Returns true if this is the primary server, false otherwise. } { - # we're using IP:port to uniquely identify the canonical server, since - # hostname or IP does not always uniquely identify an instance of - # aolserver (for instance, if we have the aolservers sitting behind a - # load balancer). we could put something into the /home/aol30/server.ini file - # but since we don't distribute a standard .ini file in the ACS, - # we don't want to do that. richardl@arsdigita.com, 28 June 2000. +ad_proc -private ad_canonical_server_p {} { + Returns true if this is the primary server, false otherwise. + + we're using IP:port to uniquely identify the canonical server, since + hostname or IP does not always uniquely identify an instance of + aolserver (for instance, if we have the aolservers sitting behind a + load balancer). +} { set canonical_server [ad_parameter -package_id [ad_acs_kernel_id] CanonicalServer server-cluster] if { [empty_string_p $canonical_server] } { - ns_log Error "Error: Your .ini file is set up incorrectly for server clustering. Please ensure that you have the CanonicalServer parameter set correctly." + ns_log Error "Your configuration is not correct for server clustering. Please ensure that you have the CanonicalServer parameter set correctly." return 1 }