Changeset 10825 for trunk/src/bp-activity/bp-activity-notifications.php

Timestamp:

05/29/2016 06:12:08 PM (7 years ago)

Author:

djpaul

Message:

Remove redundant @uses PHPDoc tag from inline documentation.

Per WordPress' inline documentation standards, the @uses tag is not recommended to be used to indicate a used-by relationship, as this information can be derived through other means. These tags also are very likely to become out-of-date as our functions change over time.

File:

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

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

@@ -17 +17 @@
  *
  * @since 1.2.0
- *
- * @uses bp_notifications_add_notification()
- * @uses bp_get_user_meta()
- * @uses bp_core_get_user_displayname()
- * @uses bp_activity_get_permalink()
- * @uses bp_core_get_user_domain()
- * @uses bp_get_settings_slug()
- * @uses bp_activity_filter_kses()
- * @uses bp_core_get_core_userdata()
- * @uses wp_specialchars_decode()
- * @uses get_blog_option()
- * @uses bp_is_active()
- * @uses bp_is_group()
- * @uses bp_get_current_group_name()
- * @uses apply_filters() To call the 'bp_activity_at_message_notification_to' hook.
- * @uses apply_filters() To call the 'bp_activity_at_message_notification_subject' hook.
- * @uses apply_filters() To call the 'bp_activity_at_message_notification_message' hook.
- * @uses wp_mail()
- * @uses do_action() To call the 'bp_activity_sent_mention_email' hook.
  *
  * @param int $activity_id      The ID of the activity update.
@@ -108 +89 @@
  * @since 1.2.0
  * @since 2.5.0 Updated to use new email APIs.
- *
- * @uses bp_get_user_meta()
- * @uses bp_core_get_user_displayname()
- * @uses bp_activity_get_permalink()
- * @uses bp_core_get_user_domain()
- * @uses bp_get_settings_slug()
- * @uses bp_activity_filter_kses()
- * @uses bp_core_get_core_userdata()
- * @uses wp_specialchars_decode()
- * @uses get_blog_option()
- * @uses bp_get_root_blog_id()
- * @uses apply_filters() To call the 'bp_activity_new_comment_notification_to' hook.
- * @uses apply_filters() To call the 'bp_activity_new_comment_notification_subject' hook.
- * @uses apply_filters() To call the 'bp_activity_new_comment_notification_message' hook.
- * @uses wp_mail()
- * @uses do_action() To call the 'bp_activity_sent_reply_to_update_email' hook.
- * @uses apply_filters() To call the 'bp_activity_new_comment_notification_comment_author_to' hook.
- * @uses apply_filters() To call the 'bp_activity_new_comment_notification_comment_author_subject' hook.
- * @uses apply_filters() To call the 'bp_activity_new_comment_notification_comment_author_message' hook.
- * @uses do_action() To call the 'bp_activity_sent_reply_to_reply_email' hook.
  *
  * @param int   $comment_id   The comment id.
@@ -243 +204 @@
  * @since 1.5.0
  *
- * @uses bp_loggedin_user_domain()
- * @uses bp_get_activity_slug()
- * @uses bp_core_get_user_displayname()
- * @uses apply_filters() To call the 'bp_activity_multiple_at_mentions_notification' hook.
- * @uses apply_filters() To call the 'bp_activity_single_at_mentions_notification' hook.
- * @uses do_action() To call 'activity_format_notifications' hook.
- *
  * @param string $action            The type of activity item. Just 'new_at_mention' for now.
  * @param int    $item_id           The activity ID.
@@ -454 +408 @@
  *
  * @param int $user_id The id of the user whose notifications are marked as read.
- * @uses bp_notifications_mark_all_notifications_by_type()
  */
 function bp_activity_remove_screen_notifications( $user_id = 0 ) {