Changeset 9026 for trunk/src/bp-groups/bp-groups-activity.php

Timestamp:

09/17/2014 12:39:27 AM (11 years ago)

Author:

boonebgorges

Message:

Improved inline documentation in bp-groups

See #5022

File:

• trunk/src/bp-groups/bp-groups-activity.php (modified) (6 diffs)

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

@@ -16 +16 @@
 /**
  * Register activity actions for the Groups component.
+ *
+ * @return bool|null False on failure.
  */
 function groups_register_activity_actions() {
@@ -240 +242 @@
  * @param int $group_id Optional. The ID of the group whose last_activity is
  *        being updated. Default: the current group's ID.
+ * @return bool|null False on failure.
  */
 function groups_update_last_activity( $group_id = 0 ) {
@@ -262 +265 @@
  *
  * @since BuddyPress (1.9.0)
- * @param int $user_id
- * @param int $group_id
+ *
+ * @param int $user_id ID of the user joining the group.
+ * @param int $group_id ID of the group.
+ * @return bool|null False on failure.
  */
 function bp_groups_membership_accepted_add_activity( $user_id, $group_id ) {
@@ -286 +291 @@
 
 /**
- * Delete all group activity from activity streams
+ * Delete all activity items related to a specific group.
  *
  * @since BuddyPress (1.9.0)
+ *
+ * @param int $group_id ID of the group.
  */
 function bp_groups_delete_group_delete_all_activity( $group_id ) {
@@ -301 +308 @@
 
 /**
- * Delete group member activity if they leave or are removed within 5 minutes of
- * membership modification.
+ * Delete group member activity if they leave or are removed within 5 minutes of membership modification.
  *
  * If the user joined this group less than five minutes ago, remove the
@@ -309 +315 @@
  *
  * @since BuddyPress (1.9.0)
+ *
+ * @param int $group_id ID of the group.
+ * @param int $user_id ID of the user leaving the group.
  */
 function bp_groups_leave_group_delete_recent_activity( $group_id, $user_id ) {