Changeset 9995 for trunk/src/bp-friends/bp-friends-cache.php

Timestamp:

07/04/2015 10:23:19 PM (9 years ago)

Author:

tw2113

Message:

Docs cleanup for Friends component.

See #6400.

File:

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

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

@@ -18 +18 @@
  *
  * @param int $friendship_id ID of the friendship whose two members should
- *        have their friends cache busted.
+ *                           have their friends cache busted.
+ *
+ * @return bool
  */
 function friends_clear_friend_object_cache( $friendship_id ) {
@@ -37 +39 @@
  * @since BuddyPress (2.0.0)
  *
- * @param int $friend_user_id The user ID not initiating the friendship
+ * @param int $friend_user_id The user ID not initiating the friendship.
  */
 function bp_friends_clear_request_cache( $friend_user_id ) {
@@ -50 +52 @@
  * @since BuddyPress (2.0.0)
  *
- * @param int $friendship_id The friendship ID
- * @param int $initiator_user_id The user ID initiating the friendship
- * @param int $friend_user_id The user ID not initiating the friendship
+ * @param int $friendship_id     The friendship ID.
+ * @param int $initiator_user_id The user ID initiating the friendship.
+ * @param int $friend_user_id    The user ID not initiating the friendship.
  */
 function bp_friends_clear_request_cache_on_save( $friendship_id, $initiator_user_id, $friend_user_id ) {
@@ -67 +69 @@
  * @since BuddyPress (2.0.0)
  *
- * @param int $friendship_id The friendship ID
+ * @param int                   $friendship_id The friendship ID.
  * @param BP_Friends_Friendship $friendship
  */
 function bp_friends_clear_request_cache_on_remove( $friendship_id, BP_Friends_Friendship $friendship ) {
-    bp_friends_clear_request_cache( $friendship->friend_user_id );  
+    bp_friends_clear_request_cache( $friendship->friend_user_id );
 }
 add_action( 'friends_friendship_withdrawn', 'bp_friends_clear_request_cache_on_remove', 10, 2 );