Changeset 7556 for trunk/bp-friends/bp-friends-cache.php

Timestamp:

11/10/2013 02:43:45 AM (12 years ago)

Author:

boonebgorges

Message:

Improve inline docs in bp-friends. See #5022

File:

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

trunk/bp-friends/bp-friends-cache.php

@@ -2 +2 @@
 
 /**
- * BuddyPress Friends Caching
+ * BuddyPress Friends Caching.
  *
  * Caching functions handle the clearing of cached objects and pages on specific
@@ -15 +15 @@
 if ( !defined( 'ABSPATH' ) ) exit;
 
+/**
+ * Clear friends-related cache for members of a specific friendship.
+ *
+ * @param int $friendship_id ID of the friendship whose two members should
+ *        have their friends cache busted.
+ */
 function friends_clear_friend_object_cache( $friendship_id ) {
     if ( !$friendship = new BP_Friends_Friendship( $friendship_id ) )
@@ -23 +29 @@
 }
 
+/**
+ * Clear friend-related notifications when ?new=1.
+ */
 function friends_clear_friend_notifications() {
     if ( isset( $_GET['new'] ) ) {