Changeset 7396

Timestamp:

10/08/2013 08:57:45 PM (11 years ago)

Author:

boonebgorges

Message:

Inline doc improvements for bp-activity-cache.php

See #5022

File:

• trunk/bp-activity/bp-activity-cache.php (modified) (3 diffs)

trunk/bp-activity/bp-activity-cache.php

@@ -2 +2 @@
 
 /**
- * Functions related to the BuddyPress Activity component and the WP Cache
+ * Functions related to the BuddyPress Activity component and the WP Cache.
  *
  * @since BuddyPress (1.6)
@@ -11 +11 @@
 
 /**
- * Slurps up activitymeta
+ * Slurp up activitymeta for a specified set of activity items.
  *
- * This function is called in two places in the BP_Groups_Group class:
- *   - in the populate() method, when single group objects are populated
+ * This function is called in two places in the BP_Activity_Activity class:
+ *   - in the populate() method, when single activity objects are populated
  *   - in the get() method, when multiple groups are queried
  *
- * It grabs all groupmeta associated with all of the groups passed in $group_ids and adds it to
- * the WP cache. This improves efficiency when using groupmeta inline
+ * It grabs all activitymeta associated with all of the activity items passed
+ * in $activity_ids and adds it to the WP cache. This improves efficiency when
+ * using querying activitymeta inline.
  *
- * @param int|str|array $group_ids Accepts a single group_id, or a comma-separated list or array of
- *    group ids
+ * @param int|str|array $activity_ids Accepts a single activity ID, or a comma-
+ *                                    separated list or array of activity ids
  */
 function bp_activity_update_meta_cache( $activity_ids = false ) {
@@ -38 +39 @@
 
 /**
- * Clear the cache for all metadata of a given activity
+ * Clear the cache for all metadata of a given activity.
  *
  * @param int $activity_id