Index: openacs-4/packages/acs-mail-lite/tcl/acs-mail-lite-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-mail-lite/tcl/acs-mail-lite-procs.tcl,v diff -u -N -r1.87 -r1.87.2.1 --- openacs-4/packages/acs-mail-lite/tcl/acs-mail-lite-procs.tcl 16 Mar 2010 12:10:27 -0000 1.87 +++ openacs-4/packages/acs-mail-lite/tcl/acs-mail-lite-procs.tcl 23 May 2010 14:02:58 -0000 1.87.2.1 @@ -15,7 +15,7 @@ namespace eval acs_mail_lite { ad_proc -public get_package_id {} { - @returns package_id of this package + @return package_id of this package } { return [apm_package_id_from_key acs-mail-lite] } @@ -27,13 +27,13 @@ Returns an apm-parameter value of this package @option name parameter name @option default default parameter value - @returns apm-parameter value of this package + @return apm-parameter value of this package } { return [parameter::get -package_id [get_package_id] -parameter $name -default $default] } ad_proc -private mail_dir {} { - @returns incoming mail directory to be scanned for bounces + @return incoming mail directory to be scanned for bounces } { return [get_parameter -name "BounceMailDir"] } @@ -44,7 +44,7 @@ } { Extracts the email address out of a mail address (like Joe User ) @option email mail address to be parsed - @returns only the email address part of the mail address + @return only the email address part of the mail address } { if {![regexp {<([^>]*)>} $email all clean_email]} { return $email @@ -72,7 +72,7 @@ ad_proc -public generate_message_id { } { Generate an id suitable as a Message-Id: header for an email. - @returns valid message-id for mail header + @return valid message-id for mail header } { # The combination of high resolution time and random # value should be pretty unique. @@ -88,7 +88,7 @@ Validates if provided signature matches message_id @option signature signature to be checked @option msg message-id that the signature should be checked against - @returns boolean 0 or 1 + @return boolean 0 or 1 } { if {![regexp "(<\[\-0-9\]+\\.\[0-9\]+\\.oacs@[address_domain]>)" $message_id match id] || $signature ne [ns_sha1 $id] } { # either couldn't find message-id or signature doesn't match @@ -153,7 +153,7 @@ user_names and user_ids. If not, get the additional data from the db and return the full array. @option addresses variable to checked for array - @returns array of emails, user_names and user_ids to be used + @return array of emails, user_names and user_ids to be used for the mail procedures } { if {[catch {array set address_array $addresses}] Index: openacs-4/packages/acs-mail-lite/tcl/bounce-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-mail-lite/tcl/Attic/bounce-procs.tcl,v diff -u -N -r1.8 -r1.8.4.1 --- openacs-4/packages/acs-mail-lite/tcl/bounce-procs.tcl 13 Feb 2009 21:35:33 -0000 1.8 +++ openacs-4/packages/acs-mail-lite/tcl/bounce-procs.tcl 23 May 2010 14:02:58 -0000 1.8.4.1 @@ -15,7 +15,7 @@ #--------------------------------------- ad_proc -private bounce_prefix {} { - @returns bounce prefix for x-envelope-from + @return bounce prefix for x-envelope-from } { return [parameter::get_from_package_key -package_key "acs-mail-lite" -parameter "EnvelopePrefix"] } @@ -26,7 +26,7 @@ } { Checks if email address is bouncing mail @option email email address to be checked for bouncing - @returns boolean 1 if bouncing 0 if ok. + @return boolean 1 if bouncing 0 if ok. } { return [db_string bouncing_p {} -default 0] } @@ -37,7 +37,7 @@ } { Checks if email address of user is bouncing mail @option user_id user to be checked for bouncing - @returns boolean 1 if bouncing 0 if ok. + @return boolean 1 if bouncing 0 if ok. } { return [db_string bouncing_p {} -default 0] } @@ -53,7 +53,7 @@ @option package_id package_id of the mail sending package (needed to call package-specific code to deal with bounces) @option message_id message-id of the mail - @returns bounce address + @return bounce address } { return "[bounce_prefix]-$user_id-[ns_sha1 $message_id]-$package_id@[address_domain]" } @@ -65,7 +65,7 @@ This takes a reply address, checks it for consistency, and returns a list of user_id, package_id and bounce_signature found @option bounce_address bounce address to be checked - @returns tcl-list of user_id package_id bounce_signature + @return tcl-list of user_id package_id bounce_signature } { set regexp_str "\[[bounce_prefix]\]-(\[0-9\]+)-(\[^-\]+)-(\[0-9\]*)\@" if {![regexp $regexp_str $bounce_address all user_id signature package_id]} { Index: openacs-4/packages/acs-mail-lite/tcl/incoming-mail-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-mail-lite/tcl/Attic/incoming-mail-procs.tcl,v diff -u -N -r1.4 -r1.4.6.1 --- openacs-4/packages/acs-mail-lite/tcl/incoming-mail-procs.tcl 29 Aug 2007 12:59:34 -0000 1.4 +++ openacs-4/packages/acs-mail-lite/tcl/incoming-mail-procs.tcl 23 May 2010 14:02:58 -0000 1.4.6.1 @@ -15,7 +15,7 @@ #--------------------------------------- ad_proc -public address_domain {} { - @returns domain address to which bounces are directed to + @return domain address to which bounces are directed to } { set domain [parameter::get_from_package_key -package_key "acs-mail-lite" -parameter "BounceDomain"] if { $domain eq "" } { Index: openacs-4/packages/acs-subsite/tcl/party-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-subsite/tcl/Attic/party-procs.tcl,v diff -u -N -r1.7 -r1.7.6.1 --- openacs-4/packages/acs-subsite/tcl/party-procs.tcl 14 Dec 2007 19:23:41 -0000 1.7 +++ openacs-4/packages/acs-subsite/tcl/party-procs.tcl 23 May 2010 14:02:58 -0000 1.7.6.1 @@ -239,7 +239,7 @@ @param party_id The party_id to get the name from. @param email The email of the party - @returns The party name + @return The party name } { if {$party_id eq "" && $email eq ""} { error "You need to provide either party_id or email" Index: openacs-4/packages/acs-tcl/tcl/security-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/security-procs.tcl,v diff -u -N -r1.61 -r1.61.2.1 --- openacs-4/packages/acs-tcl/tcl/security-procs.tcl 15 Mar 2010 00:10:53 -0000 1.61 +++ openacs-4/packages/acs-tcl/tcl/security-procs.tcl 23 May 2010 14:02:58 -0000 1.61.2.1 @@ -1651,7 +1651,7 @@ } ad_proc -public security::locations {} { - @returns insecure location and secure location followed possibly by alternate insecure location(s) as a list. + @return insecure location and secure location followed possibly by alternate insecure location(s) as a list. The location consists of protocol://domain:port for website. This proc is ported from ec_insecure_location and ec_secure_location for reliably getting locations. If acs-tcl's SuppressHttpPort parameter is true, then the alternate ec_insecure_location without port is appended to the list, since it is a valid alternate. This proc also assumes hostnames from host_node_map table are accurate and legit. } { Index: openacs-4/packages/acs-tcl/tcl/test/file-test-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-tcl/tcl/test/file-test-procs.tcl,v diff -u -N -r1.8 -r1.8.4.1 --- openacs-4/packages/acs-tcl/tcl/test/file-test-procs.tcl 12 Feb 2009 15:51:23 -0000 1.8 +++ openacs-4/packages/acs-tcl/tcl/test/file-test-procs.tcl 23 May 2010 14:02:58 -0000 1.8.4.1 @@ -41,7 +41,7 @@ aa_log "$good good of $nfiles checked" } -aa_register_case -cats {smoke production_safe} -error_level notice files__tcl_file_common_errors { +aa_register_case -cats {smoke production_safe} -error_level error files__tcl_file_common_errors { Check for some common error patterns. @author Jeff Davis davis@xarg.net @@ -59,16 +59,18 @@ #inspect every tcl file in the directory tree starting with $startdir foreach file [ad_find_all_files -check_file_func ::tcl_p $startdir] { + if {[string match */acs-tcl/tcl/test/file-test-procs.tcl $file]} continue + set fp [open $file "r"] set data [read $fp] close $fp - if {![regexp {/packages/acs-tcl/tcl/test/acs-tcl-test-procs\.tcl$} $file match]} { - if {[string first @returns $data] < 0} { - aa_log_result fail "$file should not contain '@returns'. @returns is probably a typo of @return" - } - } + if {[string first @returns $data] > -1} { + aa_log_result fail "$file should not contain '@returns'. @returns is probably a typo of @return" + } + } + aa_log "Checked $count tcl files" }