Changeset 46763

Timestamp:

11/23/2019 06:49:59 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing @since tags for functions in wp-admin/includes/update.php.

Props sathyapulse, zodiac1978.
Fixes #48777.

Location:

trunk/src/wp-admin

Files:

• includes/update.php (modified) (14 diffs)
• update-core.php (modified) (1 diff)

trunk/src/wp-admin/includes/update.php

@@ -9 +9 @@
 /**
  * Selects the first update version from the update_core option.
+ *
+ * @since 2.7.0
  *
  * @return object|array|false The response from the API on success, false on failure.
@@ -24 +26 @@
 
 /**
- * Get available core updates.
+ * Gets available core updates.
+ *
+ * @since 2.7.0
  *
  * @param array $options Set $options['dismissed'] to true to show dismissed upgrades too,
@@ -73 +77 @@
 
 /**
- * Gets the best available (and enabled) Auto-Update for WordPress Core.
- *
- * If there's 1.2.3 and 1.3 on offer, it'll choose 1.3 if the installation allows it, else, 1.2.3
+ * Gets the best available (and enabled) Auto-Update for WordPress core.
+ *
+ * If there's 1.2.3 and 1.3 on offer, it'll choose 1.3 if the installation allows it, else, 1.2.3.
  *
  * @since 3.7.0
  *
- * @return array|false False on failure, otherwise the core update offering.
+ * @return object|false The core update offering on success, false on failure.
  */
 function find_core_auto_update() {
@@ -114 +118 @@
  * @param string $version Version string to query.
  * @param string $locale  Locale to query.
- * @return bool|array False on failure. An array of checksums on success.
+ * @return array|false An array of checksums on success, false on failure.
  */
 function get_core_checksums( $version, $locale ) {
@@ -157 +161 @@
 
 /**
+ * Dismisses core update.
+ *
+ * @since 2.7.0
+ *
  * @param object $update
  * @return bool
@@ -167 +175 @@
 
 /**
+ * Undismisses core update.
+ *
+ * @since 2.7.0
+ *
  * @param string $version
  * @param string $locale
@@ -184 +196 @@
 
 /**
- * @param string $version
- * @param string $locale
- * @return object|false
+ * Finds the available update for WordPress core.
+ *
+ * @since 2.7.0
+ *
+ * @param string $version Version string to find the update for.
+ * @param string $locale  Locale to find the update for.
+ * @return object|false The core update offering on success, false on failure.
  */
 function find_core_update( $version, $locale ) {
@@ -205 +221 @@
 
 /**
+ * @since 2.3.0
+ *
  * @param string $msg
  * @return string
@@ -256 +274 @@
 
 /**
+ * @since 2.3.0
+ *
  * @global string $pagenow
  * @return false|void
@@ -302 +322 @@
 }
 
-// Called directly from dashboard
+/**
+ * Displays WordPress version and active theme in the 'At a Glance' dashboard widget.
+ *
+ * @since 2.5.0
+ */
 function update_right_now_message() {
     $theme_name = wp_get_theme();
@@ -381 +405 @@
 /**
  * Displays update information for a plugin.
+ *
+ * @since 2.3.0
  *
  * @param string $file        Plugin basename.
@@ -541 +567 @@
 
 /**
+ * @since 2.9.0
+ *
  * @return array
  */
@@ -579 +607 @@
 /**
  * Displays update information for a theme.
+ *
+ * @since 3.1.0
  *
  * @param string   $theme_key Theme stylesheet.
@@ -688 +718 @@
 
 /**
+ * @since 2.7.0
+ *
  * @global int $upgrading
  * @return false|void

trunk/src/wp-admin/update-core.php

@@ -25 +25 @@
 
 /**
+ * Lists available core updates.
+ * 
+ * @since 2.7.0
+ * 
  * @global string $wp_local_package
  * @global wpdb   $wpdb             WordPress database abstraction object.