Index: openacs-4/packages/acs-subsite/tcl/email-image-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-subsite/tcl/email-image-procs.tcl,v diff -u -r1.11 -r1.12 --- openacs-4/packages/acs-subsite/tcl/email-image-procs.tcl 7 Jun 2008 20:28:57 -0000 1.11 +++ openacs-4/packages/acs-subsite/tcl/email-image-procs.tcl 27 Oct 2014 16:39:45 -0000 1.12 @@ -13,8 +13,8 @@ -level:required } { Changes the priv_email field from the users table - @user_id - @level Change to this level + @param user_id + @param level Change to this level } { db_transaction { db_dml update_users { } @@ -25,7 +25,6 @@ -user_id:required } { Returns the priv_email field of the user from the users table. - @user_id } { set priv_level [db_string get_private_email { }] if {$priv_level eq "5"} { @@ -47,10 +46,9 @@ you can choose the background color (In this format \#xxxxxx). Also you can make the background color transparent (1 or 0). - @user_id - @return_url The url to return when the email is shown as a link - @bgcolor The Background color of the image. Default to \#ffffff - @transparent If the bgcolor is transparent. Default to 1 + @param return_url The url to return when the email is shown as a link + @param bgcolor The Background color of the image. Default to \#ffffff + @param transparent If the bgcolor is transparent. Default to 1 } { set email [email_image::get_email -user_id $user_id] set user_level [email_image::get_priv_email -user_id $user_id] @@ -103,7 +101,6 @@ } { Returns the email of the user - @user_id } { return [db_string get_email { }] } @@ -119,9 +116,8 @@ Creates the email_image of the user with his/her email on it and store it in the content repository under the Email_Images folder. - @user_id - @bgcolor The background color of the image in the format \#xxxxxx, default to \#ffffff - @transparent If you want the background color transparent set it to 1. Default to 1 + @param bgcolor The background color of the image in the format \#xxxxxx, default to \#ffffff + @param transparent If you want the background color transparent set it to 1. Default to 1 } { # First we create a type and a folder in the content repository @@ -205,9 +201,8 @@ stored it makes a new revision of the image, if not, it creates a new item with the new image. - @user_id - @bgcolor The background color of the image in the format \#xxxxxx, default to \#ffffff - @transparent If you want the background color transparent set it to 1. Default to 1 + @param bgcolor The background color of the image in the format \#xxxxxx, default to \#ffffff + @param transparent If you want the background color transparent set it to 1. Default to 1 } { if { $new_email == [email_image::get_email -user_id $user_id] } { # Email didn't change @@ -292,8 +287,8 @@ -item_id:required } { Add a new relation between user_id and item_id - @user_id - @item_id the item_id of the image in the content repository + + @param item_id the item_id of the image in the content repository } { db_exec_plsql add_relation { } } @@ -303,7 +298,6 @@ } { Returns the item_id of the email_image stored in the content repository for user_id. - @user_id } { return [db_string get_rel_item { } -default -1 ] }