diff --git a/buddylist.module b/buddylist.module index 388453d72f68d576f46addf5040907885b6661fc..79d014b8ac64b1b97357c0587af1e47b4c3debd3 100644 --- a/buddylist.module +++ b/buddylist.module @@ -9,11 +9,31 @@ function buddylist_help($field) { case 'admin/modules#description': return t('Enable buddy list functionality.'); case 'admin/help#buddylist': - return t('This help section needs to be updated.'); + $output = t(" +

Buddy list enables users to keep a list of buddies from their social network in their user account. Users can also track what their buddies are posting to the site. Furthermore, they can track their buddies' buddies and thereby explore their social network.

+

If the administrator has enabled the profile module, users can add buddies via their buddies' user profiles. On the \"View\" tab of each user's profile, there is a \"Buddy list\" section. Select the 'add buddy' action to add the user to your buddy list. If a user is already in your buddy list, the 'delete' action will remove the buddy. Administrators can also enable the buddylist block. This block allows you to see a list of your buddies. If the Friends Of A Friend (FOAF) module is enabled, it will be possible to share buddy lists with other FOAF-aware social networking applications.

+

You can

+ + +

For more information, read the configuration and customization handbook Buddylist page

", +array('%Userprofiles' => url('/profile'), + '%setaccesspermissions' => url('/admin/access/permission'), + '%blockadministration' => url('/admin/block'), + '%buddylistsettings' => url('/admin/settings/buddylist') + )); + return $output; } } -// public API for retrieving buddies. feel free to use this from other modules +/** + * Public API for retrieving buddies. Feel free to use this from other + * modules. +*/ function buddylist_get_buddies($uid = NULL) { static $buddies; @@ -32,7 +52,10 @@ function buddylist_get_buddies($uid = NULL) { return $buddies[$uid]; } -// a simple single select box suitable for use in a block or in theme, or in other module, for example +/** + * Implements a simple single select box suitable for use in a block + * or in theme, or in another module, for example. + */ function buddylist_select() { global $user; @@ -63,7 +86,7 @@ function buddylist_settings() { -// TODO. it looks like $type and $edit are unusused +// TODO. it looks like $type and $edit are unused function buddylist_setmsg_received($thisuser) { global $user; @@ -224,6 +247,9 @@ function buddylist_menu($may_cache) { return $links; } +/** + * Displays a list of a given user's buddies. + */ function buddylist_buddylisting_page($userid = NULL, $mode = 'buddies') { global $user;