From 36f47ff7510f5c0ccc7997a3b26d3f1ab42e8b05 Mon Sep 17 00:00:00 2001
From: Sergey Biryukov <sergeybiryukov@git.wordpress.org>
Date: Sat, 14 Nov 2020 16:21:19 +0000
Subject: [PATCH] Docs: Add missing descriptions for `Automatic_Upgrader_Skin`
 methods.

Props johannadevos, dilipbheda.
Fixes #44546.

git-svn-id: https://develop.svn.wordpress.org/trunk@49596 602fd350-edb4-49c9-b593-d223f7449a82
---
 .../class-automatic-upgrader-skin.php         | 20 ++++++++++++++++---
 .../includes/class-wp-ajax-upgrader-skin.php  |  6 +++---
 2 files changed, 20 insertions(+), 6 deletions(-)

diff --git a/src/wp-admin/includes/class-automatic-upgrader-skin.php b/src/wp-admin/includes/class-automatic-upgrader-skin.php
index 9875c6dee5..1835b3952c 100644
--- a/src/wp-admin/includes/class-automatic-upgrader-skin.php
+++ b/src/wp-admin/includes/class-automatic-upgrader-skin.php
@@ -8,7 +8,7 @@
  */
 
 /**
- * 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
  * is captured and stored for the caller to process and log/email/discard.
@@ -52,14 +52,22 @@ class Automatic_Upgrader_Skin extends WP_Upgrader_Skin {
 	}
 
 	/**
-	 * @return array
+	 * Retrieves the upgrade messages.
+	 *
+	 * @since 3.7.0
+	 *
+	 * @return array Messages during an upgrade.
 	 */
 	public function get_upgrade_messages() {
 		return $this->messages;
 	}
 
 	/**
-	 * @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.
 	 */
 	public function feedback( $data, ...$args ) {
@@ -103,12 +111,18 @@ class Automatic_Upgrader_Skin extends WP_Upgrader_Skin {
 	}
 
 	/**
+	 * Creates a new output buffer.
+	 *
+	 * @since 3.7.0
 	 */
 	public function header() {
 		ob_start();
 	}
 
 	/**
+	 * Retrieves the buffered content, deletes the buffer, and processes the output.
+	 *
+	 * @since 3.7.0
 	 */
 	public function footer() {
 		$output = ob_get_clean();
diff --git a/src/wp-admin/includes/class-wp-ajax-upgrader-skin.php b/src/wp-admin/includes/class-wp-ajax-upgrader-skin.php
index cd4175cd47..27d8beb740 100644
--- a/src/wp-admin/includes/class-wp-ajax-upgrader-skin.php
+++ b/src/wp-admin/includes/class-wp-ajax-upgrader-skin.php
@@ -81,7 +81,7 @@ class WP_Ajax_Upgrader_Skin extends Automatic_Upgrader_Skin {
 	}
 
 	/**
-	 * Stores a log entry for an error.
+	 * Stores an error message about the upgrade.
 	 *
 	 * @since 4.6.0
 	 * @since 5.3.0 Formalized the existing `...$args` parameter by adding it
@@ -116,13 +116,13 @@ class WP_Ajax_Upgrader_Skin extends Automatic_Upgrader_Skin {
 	}
 
 	/**
-	 * Stores a log entry.
+	 * Stores a message about the upgrade.
 	 *
 	 * @since 4.6.0
 	 * @since 5.3.0 Formalized the existing `...$args` parameter by adding it
 	 *              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.
 	 */
 	public function feedback( $data, ...$args ) {