Docs: Standardize and clarify class DocBlocks for all of the Upgrade API classes.

Standardizes summaries and tags for the following classes:

* `WP_Upgrader`
* `Plugin_Upgrader`
* `Theme_Upgrader`
* `Language_Pack_Upgrader`
* `Core_Upgrader`
* `File_Upload_Upgrader`
* `WP_Automatic_Updater`

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@34499 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-09-24 14:53:46 +00:00
parent cccd9356fe
commit b408cd37fb

View File

@ -14,10 +14,9 @@
require ABSPATH . 'wp-admin/includes/class-wp-upgrader-skins.php';
/**
* WordPress Upgrader class for Upgrading/Installing a local set of files via the Filesystem Abstraction classes from a Zip file.
* Core class used for upgrading/installing a local set of files via
* the Filesystem Abstraction classes from a Zip file.
*
* @package WordPress
* @subpackage Upgrader
* @since 2.8.0
*/
class WP_Upgrader {
@ -753,11 +752,14 @@ class WP_Upgrader {
}
/**
* Plugin Upgrader class for WordPress Plugins, It is designed to upgrade/install plugins from a local zip, remote zip URL, or uploaded zip file.
* Core class used for upgrading/installing plugins.
*
* It is designed to upgrade/install plugins from a local zip, remote zip URL,
* or uploaded zip file.
*
* @package WordPress
* @subpackage Upgrader
* @since 2.8.0
*
* @see WP_Upgrader
*/
class Plugin_Upgrader extends WP_Upgrader {
@ -1214,11 +1216,14 @@ class Plugin_Upgrader extends WP_Upgrader {
}
/**
* Theme Upgrader class for WordPress Themes, It is designed to upgrade/install themes from a local zip, remote zip URL, or uploaded zip file.
* Core class used for upgrading/installing themes.
*
* It is designed to upgrade/install themes from a local zip, remote zip URL,
* or uploaded zip file.
*
* @package WordPress
* @subpackage Upgrader
* @since 2.8.0
*
* @see WP_Upgrader
*/
class Theme_Upgrader extends WP_Upgrader {
@ -1778,11 +1783,12 @@ class Theme_Upgrader extends WP_Upgrader {
}
/**
* Language pack upgrader, for updating translations of plugins, themes, and core.
* Core class used for updating/installing language packs (translations)
* for plugins, themes, and core.
*
* @package WordPress
* @subpackage Upgrader
* @since 3.7.0
*
* @see WP_Upgrader
*/
class Language_Pack_Upgrader extends WP_Upgrader {
@ -2106,11 +2112,14 @@ class Language_Pack_Upgrader extends WP_Upgrader {
}
/**
* Core Upgrader class for WordPress. It allows for WordPress to upgrade itself in combination with the wp-admin/includes/update-core.php file
* Core class used for updating core.
*
* It allows for WordPress to upgrade itself in combination with
* the wp-admin/includes/update-core.php file.
*
* @package WordPress
* @subpackage Upgrader
* @since 2.8.0
*
* @see WP_Upgrader
*/
class Core_Upgrader extends WP_Upgrader {
@ -2443,10 +2452,11 @@ class Core_Upgrader extends WP_Upgrader {
}
/**
* Upgrade Skin helper for File uploads. This class handles the upload process and passes it as if it's a local file to the Upgrade/Installer functions.
* Core class used for handling file uploads.
*
* This class handles the upload process and passes it as if it's a local file
* to the Upgrade/Installer functions.
*
* @package WordPress
* @subpackage Upgrader
* @since 2.8.0
*/
class File_Upload_Upgrader {
@ -2558,10 +2568,8 @@ class File_Upload_Upgrader {
}
/**
* The WordPress automatic background updater.
* Core class used for handling automatic background updates.
*
* @package WordPress
* @subpackage Upgrader
* @since 3.7.0
*/
class WP_Automatic_Updater {