Changeset 10825 for trunk/src/bp-activity/bp-activity-actions.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-actions.php (modified) (13 diffs)

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

@@ -18 +18 @@
  * @since 1.2.0
  *
- * @uses do_action() To call 'bp_register_activity_actions' hook.
  */
 function bp_register_activity_actions() {
@@ -35 +34 @@
  *
  * @since 1.2.0
- *
- * @uses bp_is_activity_component()
- * @uses bp_is_current_action()
- * @uses bp_action_variable()
- * @uses bp_activity_get_specific()
- * @uses bp_is_active()
- * @uses bp_core_get_user_domain()
- * @uses groups_get_group()
- * @uses bp_get_group_permalink()
- * @uses apply_filters_ref_array() To call the 'bp_activity_permalink_redirect_url' hook.
- * @uses bp_core_redirect()
- * @uses bp_get_root_domain()
  *
  * @return bool False on failure.
@@ -123 +110 @@
  * @since 1.1.0
  *
- * @uses bp_is_activity_component()
- * @uses bp_is_current_action()
- * @uses bp_action_variable()
- * @uses check_admin_referer()
- * @uses bp_activity_user_can_delete()
- * @uses do_action() Calls 'bp_activity_before_action_delete_activity' hook to allow actions to be taken before the activity is deleted.
- * @uses bp_activity_delete()
- * @uses bp_core_add_message()
- * @uses do_action() Calls 'bp_activity_action_delete_activity' hook to allow actions to be taken after the activity is deleted.
- * @uses bp_core_redirect()
- *
  * @param int $activity_id Activity id to be deleted. Defaults to 0.
  * @return bool False on failure.
@@ -267 +243 @@
  *
  * @since 1.2.0
- *
- * @uses is_user_logged_in()
- * @uses bp_is_activity_component()
- * @uses bp_is_current_action()
- * @uses check_admin_referer()
- * @uses apply_filters() To call 'bp_activity_post_update_content' hook.
- * @uses apply_filters() To call 'bp_activity_post_update_object' hook.
- * @uses apply_filters() To call 'bp_activity_post_update_item_id' hook.
- * @uses bp_core_add_message()
- * @uses bp_core_redirect()
- * @uses bp_activity_post_update()
- * @uses groups_post_update()
- * @uses bp_core_redirect()
- * @uses apply_filters() To call 'bp_activity_custom_update' hook.
  *
  * @return bool False on failure.
@@ -372 +334 @@
  * @since 1.2.0
  *
- * @uses is_user_logged_in()
- * @uses bp_is_activity_component()
- * @uses bp_is_current_action()
- * @uses check_admin_referer()
- * @uses apply_filters() To call 'bp_activity_post_comment_activity_id' hook.
- * @uses apply_filters() To call 'bp_activity_post_comment_content' hook.
- * @uses bp_core_add_message()
- * @uses bp_core_redirect()
- * @uses bp_activity_new_comment()
- * @uses wp_get_referer()
- *
  * @return bool False on failure.
  */
@@ -436 +387 @@
  * @since 1.2.0
  *
- * @uses is_user_logged_in()
- * @uses bp_is_activity_component()
- * @uses bp_is_current_action()
- * @uses check_admin_referer()
- * @uses bp_activity_add_user_favorite()
- * @uses bp_action_variable()
- * @uses bp_core_add_message()
- * @uses bp_core_redirect()
- * @uses wp_get_referer()
- *
  * @return bool False on failure.
  */
@@ -470 +411 @@
  * @since 1.2.0
  *
- * @uses is_user_logged_in()
- * @uses bp_is_activity_component()
- * @uses bp_is_current_action()
- * @uses check_admin_referer()
- * @uses bp_activity_remove_user_favorite()
- * @uses bp_action_variable()
- * @uses bp_core_add_message()
- * @uses bp_core_redirect()
- * @uses wp_get_referer()
- *
  * @return bool False on failure.
  */
@@ -504 +435 @@
  * @since 1.0.0
  *
- * @uses bp_is_activity_component()
- * @uses bp_is_current_action()
- * @uses bp_is_user()
- * @uses status_header()
- *
  * @return bool False on failure.
  */
@@ -536 +462 @@
  * @since 1.0.0
  *
- * @uses bp_is_user_activity()
- * @uses bp_is_current_action()
- * @uses status_header()
- *
  * @return bool False on failure.
  */
@@ -566 +488 @@
  * @since 1.0.0
  *
- * @uses bp_is_active()
- * @uses bp_is_user_activity()
- * @uses bp_is_current_action()
- * @uses bp_get_friends_slug()
- * @uses bp_is_action_variable()
- * @uses status_header()
- *
  * @return bool False on failure.
  */
@@ -598 +513 @@
  *
  * @since 1.2.0
- *
- * @uses bp_is_active()
- * @uses bp_is_user_activity()
- * @uses bp_is_current_action()
- * @uses bp_get_groups_slug()
- * @uses bp_is_action_variable()
- * @uses status_header()
  *
  * @return bool False on failure.
@@ -640 +548 @@
  * @since 1.2.0
  *
- * @uses bp_is_user_activity()
- * @uses bp_is_current_action()
- * @uses bp_is_action_variable()
- * @uses status_header()
- *
  * @return bool False on failure.
  */
@@ -676 +579 @@
  *
  * @since 1.2.0
- *
- * @uses bp_is_user_activity()
- * @uses bp_is_current_action()
- * @uses bp_is_action_variable()
- * @uses status_header()
  *
  * @return bool False on failure.