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

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

@@ -263 +263 @@
      *
      * @param int $user_id Optional. If provided, the function will simply
-     *        return this value.
+     *                     return this value.
+     *
      * @return int ID of potential friend.
      */
@@ -290 +291 @@
  *
  * @param int $user_id ID of the potential friend. Default: the value of
- *        {@link bp_get_potential_friend_id()}.
+ *                     {@link bp_get_potential_friend_id()}.
+ *
  * @return string 'is_friend', 'not_friends', or 'pending'.
  */
@@ -319 +321 @@
  * @see bp_get_add_friend_button() for information on arguments.
  *
- * @param int $potential_friend_id See {@link bp_get_add_friend_button()}.
- * @param int $friend_status See {@link bp_get_add_friend_button()}.
+ * @param int      $potential_friend_id See {@link bp_get_add_friend_button()}.
+ * @param int|bool $friend_status       See {@link bp_get_add_friend_button()}.
  */
 function bp_add_friend_button( $potential_friend_id = 0, $friend_status = false ) {
@@ -328 +330 @@
      * Create the Add Friend button.
      *
-     * @param int $potential_friend_id ID of the user to whom the button
-     *        applies. Default: value of {@link bp_get_potential_friend_id()}.
-     * @param bool $friend_status Not currently used.
+     * @param int  $potential_friend_id ID of the user to whom the button
+     *                                  applies. Default: value of {@link bp_get_potential_friend_id()}.
+     * @param bool $friend_status       Not currently used.
+     *
      * @return string HTML for the Add Friend button.
      */
@@ -427 +430 @@
  *
  * @param int $user_id Optional. Default: the displayed user's ID, or the
- *        logged-in user's ID.
+ *                     logged-in user's ID.
+ *
  * @return string|bool A comma-separated list of friend IDs if any are found,
- *         otherwise false.
+ *                     otherwise false.
  */
 function bp_get_friend_ids( $user_id = 0 ) {
@@ -451 +455 @@
  *
  * @param int $user_id ID of the user whose requests are being retrieved.
- *        Defaults to displayed user.
+ *                     Defaults to displayed user.
+ *
  * @return array|int An array of user IDs if found, or a 0 if none are found.
  */
@@ -580 +585 @@
      *
      * @param int $user_id See {@link friends_get_total_friend_count()}.
+     *
      * @return int Total friend count.
      */
@@ -609 +615 @@
      *
      * @param int $user_id ID of the user whose requests are being counted.
-     *        Default: ID of the logged-in user.
+     *                     Default: ID of the logged-in user.
+     *
      * @return int Friend count.
      */
@@ -633 +640 @@
  * @since BuddyPress (2.0.0)
  *
- * @param array $args before|after|user_id
- * @uses bp_friends_get_profile_stats() to get the stats
+ * @uses bp_friends_get_profile_stats() to get the stats.
+ *
+ * @param array|string $args before|after|user_id
  */
 function bp_friends_profile_stats( $args = '' ) {
@@ -646 +654 @@
  * @since BuddyPress (2.0.0)
  *
- * @param array $args before|after|user_id
+ * @param array|string $args before|after|user_id
+ *
  * @return string HTML for stats output.
  */
@@ -682 +691 @@
      *
      * @param string $value Formatted string displaying total friends count.
-     * @param array  $r Array of arguments for string formatting and output.
+     * @param array  $r     Array of arguments for string formatting and output.
      */
     return apply_filters( 'bp_friends_get_profile_stats', $r['output'], $r );