Changeset 9164

Timestamp:

11/22/2014 01:16:42 AM (10 years ago)

Author:

boonebgorges

Message:

Improve some docblocks in bp-messages-classes.php.

Props slaFFik.
See #5193.

File:

• trunk/src/bp-messages/bp-messages-classes.php (modified) (6 diffs)

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

@@ -110 +110 @@
      * @since BuddyPress (1.0.0)
      *
-     * @param int $thread_id The message thread ID.
+     * @param bool|int $thread_id The message thread ID.
      * @param string $order The order to sort the messages. Either 'ASC' or 'DESC'.
      */
@@ -128 +128 @@
      * @param int $thread_id The message thread ID.
      * @param string $order The order to sort the messages. Either 'ASC' or 'DESC'.
+     * @return bool False on failure.
      */
     public function populate( $thread_id, $order ) {
@@ -362 +363 @@
      *
      * @param int $thread_id The message thread ID.
-     * @param bool
+     * @return bool
      */
     public static function user_is_sender( $thread_id ) {
@@ -469 +470 @@
      * @since BuddyPress (1.0.0)
      *
-     * @param object $recipients Object containing the message recipients.
+     * @param array $recipients Array containing the message recipients (array of objects).
      * @return string
      */
@@ -791 +792 @@
      *
      * @since BuddyPress (1.0.0)
+     * @param int $id Optional. The ID of the current notice.
      */
     public function __construct( $id = null ) {
@@ -912 +914 @@
      * @since BuddyPress (1.0.0)
      *
-     * @param array $data {
+     * @param array $args {
      *     Array of parameters.
      *     @type int $pag_num Number of notices per page. Defaults to 20.