Index: openacs-4/packages/dotlrn-faq/tcl/dotlrn-faq-procs.tcl =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/dotlrn-faq/tcl/dotlrn-faq-procs.tcl,v diff -u -r1.45 -r1.46 --- openacs-4/packages/dotlrn-faq/tcl/dotlrn-faq-procs.tcl 30 Jun 2018 22:04:28 -0000 1.45 +++ openacs-4/packages/dotlrn-faq/tcl/dotlrn-faq-procs.tcl 11 Jul 2018 08:16:01 -0000 1.46 @@ -27,12 +27,15 @@ ad_proc -public get_pretty_name { } { - get the pretty name + Get the pretty name. } { return "#faq.pretty_name#" } - ad_proc -public applet_key {} { + ad_proc -public applet_key { + } { + Get the applet key. + } { return "dotlrn_faq" } @@ -61,15 +64,15 @@ community_id package_id } { - remove the applet + Remove the applet. } { ad_return_complaint 1 "[applet_key] remove_applet not implemented!" } ad_proc -public add_applet_to_community { community_id } { - Add the faq applet to a specific community + Add the faq applet to a specific community. } { set portal_id [dotlrn_community::get_portal_id \ -community_id $community_id @@ -115,15 +118,15 @@ ad_proc -public remove_applet_from_community { community_id } { - Drops the faq applet from the given community + Drops the faq applet from the given community. } { ad_return_complaint 1 "[applet_key] remove_applet_from_community not implemented!" } ad_proc -public add_user { user_id } { - For one time user-specific init + For one time user-specific init. } { # noop } @@ -140,7 +143,7 @@ community_id user_id } { - Called when a user is added to a specific dotlrn community + Called when a user is added to a specific dotlrn community. } { set portal_id [dotlrn::get_portal_id -user_id $user_id] set package_id [dotlrn_community::get_applet_package_id \ @@ -159,7 +162,7 @@ community_id user_id } { - Remove a user from a community + Remove a user from a community. } { set portal_id [dotlrn::get_portal_id -user_id $user_id] set package_id [dotlrn_community::get_applet_package_id \ @@ -221,7 +224,7 @@ old_community_id new_community_id } { - Clone this applet's content from the old community to the new one + Clone this applet's content from the old community to the new one. } { ns_log notice "Cloning: [applet_key]" set new_package_id [add_applet_to_community $new_community_id] @@ -240,8 +243,8 @@ old_value new_value } { - listens for the following events: - } { + Listens for the events. This is currently empty. + } { } }