Changeset 13890 for trunk/src/bp-friends/bp-friends-functions.php

Timestamp:

06/02/2024 01:06:10 AM (6 months ago)

Author:

espellcaste

Message:

PHPDoc: remove superfluous comments from boolean returns.

See #9164

File:

• trunk/src/bp-friends/bp-friends-functions.php (modified) (5 diffs)

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

@@ -29 +29 @@
  *                               When true, running friends_add_friend() will result in an accepted
  *                               friendship, with no notifications being sent. Default: false.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function friends_add_friend( $initiator_userid, $friend_userid, $force_accept = false ) {
@@ -97 +97 @@
  * @param int $initiator_userid ID of the friendship initiator.
  * @param int $friend_userid    ID of the friend user.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function friends_remove_friend( $initiator_userid, $friend_userid ) {
@@ -157 +157 @@
  *
  * @param int $friendship_id ID of the pending friendship object.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function friends_accept_friendship( $friendship_id ) {
@@ -194 +194 @@
  *
  * @param int $friendship_id ID of the pending friendship object.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function friends_reject_friendship( $friendship_id ) {
@@ -225 +225 @@
  *                              user who requested the friendship, and is doing the withdrawing.
  * @param int $friend_userid    ID of the requested friend.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function friends_withdraw_friendship( $initiator_userid, $friend_userid ) {