Changeset 9027 for trunk/src/bp-groups/bp-groups-notifications.php

Timestamp:

09/17/2014 01:49:22 AM (10 years ago)

Author:

boonebgorges

Message:

Improved inline documentation in bp-groups

See #5022

File:

• trunk/src/bp-groups/bp-groups-notifications.php (modified) (13 diffs)

trunk/src/bp-groups/bp-groups-notifications.php

@@ -17 +17 @@
 
 /**
- * Notify all group members when a group is updated
+ * Notify all group members when a group is updated.
  *
  * @since BuddyPress (1.0.0)
  *
- * @param int $group_id
+ * @param int $group_id ID of the group.
  */
 function groups_notification_group_updated( $group_id = 0 ) {
@@ -69 +69 @@
 
 /**
- * Notify group admin about new membership request
+ * Notify group admin about new membership request.
  *
  * @since BuddyPress (1.0.0)
  *
- * @param int $requesting_user_id
- * @param int $admin_id
- * @param int $group_id
- * @param int $membership_id
- * @return boolean
+ * @param int $requesting_user_id ID of the user requesting group membership.
+ * @param int $admin_id ID of the group admin.
+ * @param int $group_id ID of the group.
+ * @param int $membership_id ID of the group membership object.
+ * @return bool|null False on failure.
  */
 function groups_notification_new_membership_request( $requesting_user_id = 0, $admin_id = 0, $group_id = 0, $membership_id = 0 ) {
@@ -145 +145 @@
 
 /**
- * Notify member about their group membership request
+ * Notify member about their group membership request.
  *
  * @since BuddyPress (1.0.0)
  *
- * @param type $requesting_user_id
- * @param type $group_id
- * @param type $accepted
+ * @param int $requesting_user_id ID of the user requesting group membership.
+ * @param int $group_id ID of the group.
+ * @param bool $accepted Optional. Whether the membership request was accepted.
+ *        Default: true.
  * @return boolean
  */
@@ -224 +225 @@
 
 /**
- * Notify group member they have been promoted
+ * Notify group member they have been promoted.
  *
  * @since BuddyPress (1.0.0)
  *
- * @param int $user_id
- * @param int $group_id
- * @return boolean
+ * @param int $user_id ID of the user.
+ * @param int $group_id ID of the group.
+ * @return bool|null False on failure.
  */
 function groups_notification_promoted_member( $user_id = 0, $group_id = 0 ) {
@@ -292 +293 @@
 
 /**
- * Notify a member they have been invitated to a group
+ * Notify a member they have been invited to a group.
  *
  * @since BuddyPress (1.0.0)
  *
- * @param object $group
- * @param object $member
- * @param int $inviter_user_id
- * @return boolean
+ * @param BP_Groups_Group $group Group object.
+ * @param BP_Groups_Member $member Member object.
+ * @param int $inviter_user_id ID of the user who sent the invite.
+ * @return bool|null False on failure.
  */
 function groups_notification_group_invites( &$group, &$member, $inviter_user_id ) {
@@ -375 +376 @@
  * @since BuddyPress (1.0.0)
  *
- * @param string $action The kind of notification being rendered
- * @param int $item_id The primary item id
- * @param int $secondary_item_id The secondary item id
- * @param int $total_items The total number of messaging-related notifications waiting for the user
- * @param string $format 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar
+ * @param string $action The kind of notification being rendered.
+ * @param int $item_id The primary item ID.
+ * @param int $secondary_item_id The secondary item ID.
+ * @param int $total_items The total number of messaging-related notifications
+ *        waiting for the user.
+ * @param string $format 'string' for BuddyBar-compatible notifications; 'array'
+ *        for WP Toolbar. Default: 'string'.
+ * @return string
  */
 function groups_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {
@@ -611 +615 @@
 
 /**
- * Remove all notifications for any member belonging to a specific group
+ * Remove all notifications for any member belonging to a specific group.
  *
  * @since BuddyPress (1.9.0)
+ *
+ * @param int $group_id ID of the group.
  */
 function bp_groups_delete_group_delete_all_notifications( $group_id ) {
@@ -626 +632 @@
  *
  * @since BuddyPress (2.0.0)
+ *
+ * @param int $user_id ID of the user.
+ * @param int $group_id ID of the group.
  */
 function bp_groups_delete_promotion_notifications( $user_id = 0, $group_id = 0 ) {
@@ -636 +645 @@
 
 /**
- * Mark notifications read when a member accepts a group invitation
+ * Mark notifications read when a member accepts a group invitation.
  *
  * @since BuddyPress (1.9.0)
- * @param int $user_id
- * @param int $group_id
+ *
+ * @param int $user_id ID of the user.
+ * @param int $group_id ID of the group.
  */
 function bp_groups_accept_invite_mark_notifications( $user_id, $group_id ) {
@@ -652 +662 @@
 
 /**
- * Mark notifications read when a member views their group memberships
+ * Mark notifications read when a member views their group memberships.
  *
  * @since BuddyPress (1.9.0)
@@ -676 +686 @@
 
 /**
- * Mark group invitation notifications read when a member views their invitations
+ * Mark group invitation notifications read when a member views their invitations.
  *
  * @since BuddyPress (1.9.0)
@@ -688 +698 @@
 
 /**
- * Mark group join requests read when an admin or moderator visits the group
- * administration area.
+ * Mark group join requests read when an admin or moderator visits the group administration area.
  *
  * @since BuddyPress (1.9.0)
@@ -704 +713 @@
  *
  * @since BuddyPress (1.9.0)
- * @param int $user_id
+ *
+ * @param int $user_id ID of the user.
  */
 function bp_groups_remove_data_for_user_notifications( $user_id ) {