Changeset 9862 for trunk/src/bp-messages/bp-messages-notifications.php

Timestamp:

05/12/2015 04:39:07 AM (11 years ago)

Author:

tw2113

Message:

First pass at messages component docs cleanup.

See #6403.

File:

• trunk/src/bp-messages/bp-messages-notifications.php (modified) (4 diffs)

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

@@ -20 +20 @@
  * @param array|BP_Messages_Message $raw_args {
  *     Array of arguments. Also accepts a BP_Messages_Message object.
- *     @type array $recipients User IDs of recipients.
+ *     @type array  $recipients    User IDs of recipients.
  *     @type string $email_subject Subject line of message.
  *     @type string $email_content Content of message.
- *     @type int $sender_id User ID of sender.
+ *     @type int    $sender_id     User ID of sender.
  * }
  */
@@ -154 +154 @@
  * @since BuddyPress (1.0.0)
  *
- * @param string $action The kind of notification being rendered.
- * @param int $item_id The primary item id.
- * @param int $secondary_item_id The secondary item id.
- * @param int $total_items The total number of messaging-related notifications
- *        waiting for the user
- * @param string $format Return value format. 'string' for BuddyBar-compatible
- *        notifications; 'array' for WP Toolbar. Default: 'string'.
+ * @param string $action            The kind of notification being rendered.
+ * @param int    $item_id           The primary item id.
+ * @param int    $secondary_item_id The secondary item id.
+ * @param int    $total_items       The total number of messaging-related notifications
+ *                                  waiting for the user.
+ * @param string $format            Return value format. 'string' for BuddyBar-compatible
+ *                                  notifications; 'array' for WP Toolbar. Default: 'string'.
+ *
  * @return string|array Formatted notifications.
  */
@@ -202 +203 @@
          *
          * This is a dynamic filter. Possible filter names are:
-         *   - 'bp_messages_multiple_new_message_notification'
-         *   - 'bp_messages_single_new_message_notification'
+         *   - 'bp_messages_multiple_new_message_notification'.
+         *   - 'bp_messages_single_new_message_notification'.
          *
          * @param string $retval            Notification text.
@@ -298 +299 @@
  * @since BuddyPress (2.0.0)
  *
- * @param int   $message_id  ID of the thread.
+ * @param int   $thread_id   ID of the thread.
  * @param array $message_ids IDs of the messages.
  */