Changeset 10139 for trunk/src/bp-messages/bp-messages-star.php

Timestamp:

09/25/2015 12:02:25 AM (11 years ago)

Author:

tw2113

Message:

Standardizing our @since tags for the Messages component.

See #6576.

File:

• trunk/src/bp-messages/bp-messages-star.php (modified) (18 diffs)

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

@@ -4 +4 @@
  *
  * @since BuddyPress (2.3.0)
- */
+ *
+ * @package BuddyPress
+ * @subpackage MessagesStar
+ */
+
+// Exit if accessed directly.
+defined( 'ABSPATH' ) || exit;
 
 /** UTILITY **************************************************************/
@@ -11 +17 @@
  * Return the starred messages slug. Defaults to 'starred'.
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  *
  * @return string
@@ -19 +25 @@
      * Filters the starred message slug.
      *
-     * @since BuddyPress (2.3.0)
+     * @since 2.3.0
      *
      * @param string
@@ -29 +35 @@
  * Function to determine if a message ID is starred.
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  *
  * @param  int $mid     The message ID. Please note that this isn't the message thread ID.
@@ -56 +62 @@
  * Output the link or raw URL for starring or unstarring a message.
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  *
  * @param array $args See bp_get_the_message_star_action_link() for full documentation.
@@ -66 +72 @@
      * Return the link or raw URL for starring or unstarring a message.
      *
-     * @since BuddyPress (2.3.0)
+     * @since 2.3.0
      *
      * @param array $args {
@@ -207 +213 @@
          * Filters the star action URL for starring / unstarring a message.
          *
-         * @since BuddyPress (2.3.0)
+         * @since 2.3.0
          *
          * @param string $retval URL for starring / unstarring a message.
@@ -220 +226 @@
          * Filters the star action link, including markup.
          *
-         * @since BuddyPress (2.3.0)
+         * @since 2.3.0
          *
          * @param string $retval Link for starring / unstarring a message, including markup.
@@ -231 +237 @@
  * Save or delete star message meta according to a message's star status.
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  *
  * @param array $args {
@@ -311 +317 @@
  * Screen handler to display a user's "Starred" private messages page.
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  */
 function bp_messages_star_screen() {
@@ -319 +325 @@
      * Fires right before the loading of the "Starred" messages box.
      *
-     * @since BuddyPress (2.3.0)
+     * @since 2.3.0
      */
     do_action( 'bp_messages_screen_star' );
@@ -329 +335 @@
  * Screen content callback to display a user's "Starred" messages page.
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  */
 function bp_messages_star_content() {
@@ -345 +351 @@
  * Filter message threads by those starred by the logged-in user.
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  *
  * @param  array $r Current message thread arguments.
@@ -365 +371 @@
  * Action handler to set a message's star status for those not using JS.
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  */
 function bp_messages_star_action_handler() {
@@ -402 +408 @@
  * Bulk manage handler to set the star status for multiple messages.
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  */
 function bp_messages_star_bulk_manage_handler() {
@@ -475 +481 @@
  * The dashicons font is used for the star / unstar icon.
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  */
 function bp_messages_star_enqueue_scripts() {
@@ -489 +495 @@
  * Add the "Add star" and "Remove star" options to the bulk management list.
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  */
 function bp_messages_star_bulk_management_dropdown() {
@@ -504 +510 @@
  * Add CSS class for the current message depending on starred status.
  *
- * @since BuddyPress (2.3.0)
+ * @since 2.3.0
  *
  * @param  array $retval Current CSS classes