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

Timestamp:

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

Author:

tw2113

Message:

First pass at messages component docs cleanup.

See #6403.

File:

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

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

@@ -2 +2 @@
 
 /**
- * BuddyPress Messages Caching
+ * BuddyPress Messages Caching.
  *
  * Caching functions handle the clearing of cached objects and pages on specific
@@ -22 +22 @@
  * @since BuddyPress (2.2.0)
  *
- * @param int|str|array $message_ids Accepts a single message_id, or a
- *        comma-separated list or array of message ids.
+ * @param int|string|array|bool $message_ids Accepts a single message_id, or a
+ *                                           comma-separated list or array of message ids.
  */
 function bp_messages_update_meta_cache( $message_ids = false ) {
@@ -72 +72 @@
  * @since BuddyPress (2.0.0)
  *
- * @param int|array $thread_ids If single thread, the thread ID. Otherwise, an
- *  array of thread IDs
+ * @param int|array $thread_ids If single thread, the thread ID.
+ *                              Otherwise, an array of thread IDs.
  */
 function bp_messages_clear_cache_on_message_delete( $thread_ids ) {
@@ -93 +93 @@
  *
  * @since BuddyPress (2.0.0)
+ *
+ * @param BP_Messages_Notice $notice
  */
 function bp_notices_clear_cache( $notice ) {