Changeset 6573 for trunk/src/includes/admin/tools/common.php

Timestamp:

06/16/2017 09:20:52 PM (7 years ago)

Author:

johnjamesjacoby

Message:

Documentation: Remove all @uses usages.

Per the 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/includes/admin/tools/common.php (modified) (3 diffs)

trunk/src/includes/admin/tools/common.php

@@ -57 +57 @@
  * @param string|WP_Error $message A message to be displayed or {@link WP_Error}
  * @param string $class Optional. A class to be added to the message div
- * @uses WP_Error::get_error_messages() To get the error messages of $message
- * @uses add_action() Adds the admin notice action with the message HTML
  * @return string The message HTML
  */
@@ -109 +107 @@
  * @since 2.0.0 bbPress (r2613)
  *
- * @uses bbp_admin_repair_list() To get the recount list
- * @uses check_admin_referer() To verify the nonce and the referer
- * @uses wp_cache_flush() To flush the cache
- * @uses do_action() Calls 'admin_notices' to display the notices
  */
 function bbp_admin_repair_handler() {
@@ -343 +337 @@
  * @since 2.0.0 bbPress (r2613)
  *
- * @uses apply_filters() Calls 'bbp_repair_list' with the list array
  * @return array Repair list of options
  */