Changeset 6573 for trunk/src/includes/core/update.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/core/update.php (modified) (6 diffs)

trunk/src/includes/core/update.php

@@ -16 +16 @@
  * @since 2.1.0 bbPress (r3764)
  *
- * @uses get_option()
- * @uses bbp_get_db_version() To get the database version
  * @return bool True if update, False if not
  */
@@ -29 +27 @@
  * @since 2.0.0 bbPress (r3421)
  *
- * @uses get_option()
- * @uses bbp_get_db_version() To get the database version
  * @return bool True if update, False if not
  */
@@ -147 +143 @@
  *
  * @since 2.0.0 bbPress (r3421)
- *
- * @uses update_option()
- * @uses bbp_get_db_version() To get the database version
  */
 function bbp_version_bump() {
@@ -159 +152 @@
  *
  * @since 2.0.0 bbPress (r3419)
- *
- * @uses bbp_is_update()
- * @uses bbp_version_updater()
  */
 function bbp_setup_updater() {
@@ -369 +359 @@
  * @internal Used internally to redirect bbPress to the about page on activation
  *
- * @uses is_network_admin() To bail if being network activated
- * @uses set_transient() To drop the activation transient for 30 seconds
- *
  * @return If network admin or bulk activation
  */
@@ -393 +380 @@
  *
  * @internal Used to internally make the current user a keymaster on activation
- *
- * @uses current_user_can() to bail if user cannot activate plugins
- * @uses get_current_user_id() to get the current user ID
- * @uses get_current_blog_id() to get the current blog ID
- * @uses is_user_member_of_blog() to bail if the current user does not have a role
- * @uses bbp_is_user_keymaster() to bail if the user is already a keymaster
- * @uses bbp_set_user_role() to make the current user a keymaster
  *
  * @return If user can't activate plugins or is already a keymaster