Changeset 9995 for trunk/src/bp-friends/bp-friends-activity.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-activity.php (modified) (11 diffs)

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

@@ -2 +2 @@
 
 /**
- * BuddyPress Friends Activity Functions
+ * BuddyPress Friends Activity Functions.
  *
  * These functions handle the recording, deleting and formatting of activity
@@ -23 +23 @@
  *      return values.
  *
- * @param array $args {
+ * @param array|string $args {
  *     An array of arguments for the new activity item. Accepts all parameters
  *     of {@link bp_activity_add()}. The one difference is the following
  *     argument, which has a different default here:
  *     @type string $component Default: the id of your Friends component
- *           (usually 'friends').
+ *                             (usually 'friends').
  * }
  * @return bool See {@link bp_activity_add()}.
@@ -59 +59 @@
  * @param array $args {
  *     An array of arguments for the item to delete.
- *     @type int $item_id ID of the 'item' associated with the activity item.
- *           For Friends activity items, this is usually the user ID of one
- *           of the friends.
- *     @type string $type The 'type' of the activity item (eg
- *           'friendship_accepted').
- *     @type int $user_id ID of the user associated with the activity item.
+ *     @type int    $item_id ID of the 'item' associated with the activity item.
+ *                           For Friends activity items, this is usually the user ID of one
+ *                           of the friends.
+ *     @type string $type    The 'type' of the activity item (eg
+ *                           'friendship_accepted').
+ *     @type int    $user_id ID of the user associated with the activity item.
  * }
  * @return bool True on success, false on failure.
@@ -128 +128 @@
  * @since BuddyPress (2.0.0)
  *
+ * @param string $action   Activity action string.
  * @param object $activity Activity data.
+ *
  * @return string $action Formatted activity action.
  */
@@ -150 +152 @@
      * @since BuddyPress (2.0.0)
      *
-     * @param string $action String text for the 'friendship_accepted' action.
+     * @param string $action   String text for the 'friendship_accepted' action.
      * @param object $activity Activity data.
      */
@@ -161 +163 @@
  * @since BuddyPress (2.0.0)
  *
- * @param string $action Static activity action.
+ * @param string $action   Static activity action.
  * @param object $activity Activity data.
+ *
  * @return string $action Formatted activity action.
  */
@@ -184 +187 @@
      * @since BuddyPress (2.0.0)
      *
-     * @param string $action String text for the 'friendship_created' action.
+     * @param string $action   String text for the 'friendship_created' action.
      * @param object $activity Activity data.
      */
@@ -198 +201 @@
  *
  * @param array $activities Array of activity items.
+ *
  * @return array
  */
@@ -237 +241 @@
  * @param array $retval Empty array by default
  * @param array $filter Current activity arguments
+ *
  * @return array
  */
@@ -290 +295 @@
  * @param array $retval Empty array by default
  * @param array $filter Current activity arguments
+ *
  * @return array
  */
@@ -364 +370 @@
  * @since BuddyPress (1.9.0)
  *
- * @param int $friendship_id
- * @param int $initiator_user_id
- * @param int $friend_user_id
- * @param object $friendship Optional
+ * @param int         $friendship_id
+ * @param int         $initiator_user_id
+ * @param int         $friend_user_id
+ * @param object|bool $friendship Optional
  */
 function bp_friends_friendship_accepted_activity( $friendship_id, $initiator_user_id, $friend_user_id, $friendship = false ) {