Changeset 10587 for trunk/src/bp-friends/bp-friends-template.php

Timestamp:

02/13/2016 07:32:53 PM (8 years ago)

Author:

tw2113

Message:

Addes missing @since tags to many functions, methods, and properties in the BP Friends component.

See #6400.

File:

• trunk/src/bp-friends/bp-friends-template.php (modified) (19 diffs)

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

@@ -219 +219 @@
 /**
  * Output the friend count for the current member in the loop.
+ *
+ * @since 1.2.0
  */
 function bp_member_total_friend_count() {
@@ -227 +229 @@
      *
      * Return value is a string of the form "x friends".
+     *
+     * @since 1.2.0
      *
      * @return string A string of the form "x friends".
@@ -254 +258 @@
  * Output the ID of the current user in the friend request loop.
  *
+ * @since 1.2.6
+ *
  * @see bp_get_potential_friend_id() for a description of arguments.
  *
@@ -263 +269 @@
     /**
      * Return the ID of current user in the friend request loop.
+     *
+     * @since 1.2.6
      *
      * @global object $friends_template
@@ -293 +301 @@
  * Returns - 'is_friend', 'not_friends', 'pending'.
  *
+ * @since 1.2.6
+ *
  * @param int $user_id ID of the potential friend. Default: the value of
  *                     {@link bp_get_potential_friend_id()}.
@@ -321 +331 @@
  * Output the Add Friend button.
  *
+ * @since 1.0.0
+ *
  * @see bp_get_add_friend_button() for information on arguments.
  *
@@ -331 +343 @@
     /**
      * Create the Add Friend button.
+     *
+     * @since 1.1.0
      *
      * @param int  $potential_friend_id ID of the user to whom the button
@@ -430 +444 @@
  * Get a comma-separated list of IDs of a user's friends.
  *
+ * @since 1.2.0
+ *
  * @param int $user_id Optional. Default: the displayed user's ID, or the
  *                     logged-in user's ID.
@@ -454 +470 @@
  * because of the structure of the $include parameter in bp_has_members().
  *
+ * @since 1.2.0
+ *
  * @param int $user_id ID of the user whose requests are being retrieved.
  *                     Defaults to displayed user.
@@ -487 +505 @@
 /**
  * Output the ID of the friendship between the logged-in user and the current user in the loop.
+ *
+ * @since 1.2.0
  */
 function bp_friend_friendship_id() {
@@ -493 +513 @@
     /**
      * Return the ID of the friendship between the logged-in user and the current user in the loop.
+     *
+     * @since 1.2.0
      *
      * @return int ID of the friendship.
@@ -516 +538 @@
 /**
  * Output the URL for accepting the current friendship request in the loop.
+ *
+ * @since 1.0.0
  */
 function bp_friend_accept_request_link() {
@@ -522 +546 @@
     /**
      * Return the URL for accepting the current friendship request in the loop.
+     *
+     * @since 1.0.0
      *
      * @return string accept-friendship URL.
@@ -545 +571 @@
 /**
  * Output the URL for rejecting the current friendship request in the loop.
+ *
+ * @since 1.0.0
  */
 function bp_friend_reject_request_link() {
@@ -551 +579 @@
     /**
      * Return the URL for rejecting the current friendship request in the loop.
+     *
+     * @since 1.0.0
      *
      * @return string reject-friendship URL.
@@ -575 +605 @@
  * Output the total friend count for a given user.
  *
+ * @since 1.2.0
+ *
  * @param int $user_id See {@link friends_get_total_friend_count()}.
  */
@@ -583 +615 @@
      * Return the total friend count for a given user.
      *
+     * @since 1.2.0
+     *
      * @param int $user_id See {@link friends_get_total_friend_count()}.
      * @return int Total friend count.
@@ -602 +636 @@
  * Output the total friendship request count for a given user.
  *
+ * @since 1.2.0
+ *
  * @see bp_friend_get_total_requests_count() for description of arguments.
  *
@@ -611 +647 @@
     /**
      * Return the total friendship request count for a given user.
+     *
+     * @since 1.2.0
      *
      * @param int $user_id ID of the user whose requests are being counted.