Changeset 49596

Timestamp:

11/14/2020 04:21:19 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing descriptions for Automatic_Upgrader_Skin methods.

Props johannadevos, dilipbheda.
Fixes #44546.

Location:

trunk/src/wp-admin/includes

Files:

• class-automatic-upgrader-skin.php (modified) (5 diffs)
• class-wp-ajax-upgrader-skin.php (modified) (3 diffs)

trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php

@@ -9 +9 @@
 
 /**
- * Upgrader Skin for Automatic WordPress Upgrades
+ * Upgrader Skin for Automatic WordPress Upgrades.
  *
  * This skin is designed to be used when no output is intended, all output
@@ -53 +53 @@
 
     /**
-     * @return array
+     * Retrieves the upgrade messages.
+     *
+     * @since 3.7.0
+     *
+     * @return array Messages during an upgrade.
      */
     public function get_upgrade_messages() {
@@ -60 +64 @@
 
     /**
-     * @param string|array|WP_Error $data
+     * Stores a message about the upgrade.
+     *
+     * @since 3.7.0
+     *
+     * @param string|array|WP_Error $data    Message data.
      * @param mixed                 ...$args Optional text replacements.
      */
@@ -104 +112 @@
 
     /**
+     * Creates a new output buffer.
+     *
+     * @since 3.7.0
      */
     public function header() {
@@ -110 +121 @@
 
     /**
+     * Retrieves the buffered content, deletes the buffer, and processes the output.
+     *
+     * @since 3.7.0
      */
     public function footer() {

trunk/src/wp-admin/includes/class-wp-ajax-upgrader-skin.php

@@ -82 +82 @@
 
     /**
-     * Stores a log entry for an error.
+     * Stores an error message about the upgrade.
      *
      * @since 4.6.0
@@ -117 +117 @@
 
     /**
-     * Stores a log entry.
+     * Stores a message about the upgrade.
      *
      * @since 4.6.0
@@ -123 +123 @@
      *              to the function signature.
      *
-     * @param string|array|WP_Error $data    Log entry data.
+     * @param string|array|WP_Error $data    Message data.
      * @param mixed                 ...$args Optional text replacements.
      */