Changeset 13890 for trunk/src/bp-messages/bp-messages-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-messages/bp-messages-functions.php (modified) (4 diffs)

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

@@ -215 +215 @@
  * @param string $subject Subject of the notice.
  * @param string $message Content of the notice.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function messages_send_notice( $subject, $message ) {
@@ -257 +257 @@
  * @param int       $user_id    ID of the user to delete the threads for. Defaults
  *                              to the current logged-in user.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function messages_delete_thread( $thread_ids, $user_id = 0 ) {
@@ -463 +463 @@
  * @param string|bool $meta_value Meta value to delete. Default false.
  * @param bool        $delete_all Whether or not to delete all meta data.
- *
- * @return bool True on successful delete, false on failure.
+ * @return bool
  */
 function bp_messages_delete_meta( $message_id, $meta_key = false, $meta_value = false, $delete_all = false ) {
@@ -815 +814 @@
  * @param int       $user_id    ID of the user to delete the threads for. Defaults
  *                              to the current logged-in user.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function bp_messages_exit_thread( $thread_ids, $user_id = 0 ) {