From b09cedbd11f0cf0c135f1b132600351a5f2ed486 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Thu, 20 Aug 2015 22:25:41 +0000 Subject: [PATCH] Docs: Standardize `@deprecated` tag formatting for deprecated functions in wp-admin/includes/ms-deprecated.php. Props Alphawolf for the initial patch Props DrewAPicture See #28806. git-svn-id: https://develop.svn.wordpress.org/trunk@33675 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/ms-deprecated.php | 38 ++++++++++++++++++------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/src/wp-admin/includes/ms-deprecated.php b/src/wp-admin/includes/ms-deprecated.php index 5038ad376f..8d2d00c548 100644 --- a/src/wp-admin/includes/ms-deprecated.php +++ b/src/wp-admin/includes/ms-deprecated.php @@ -10,6 +10,8 @@ */ /** + * Outputs the WPMU menu. + * * @deprecated 3.0.0 */ function wpmu_menu() { @@ -18,10 +20,10 @@ function wpmu_menu() { } /** - * Determines if the available space defined by the admin has been exceeded by the user. - * - * @deprecated 3.0.0 - * @see is_upload_space_available() + * Determines if the available space defined by the admin has been exceeded by the user. + * + * @deprecated 3.0.0 Use is_upload_space_available() + * @see is_upload_space_available() */ function wpmu_checkAvailableSpace() { _deprecated_function(__FUNCTION__, '3.0', 'is_upload_space_available()' ); @@ -31,6 +33,8 @@ function wpmu_checkAvailableSpace() { } /** + * WPMU options. + * * @deprecated 3.0.0 */ function mu_options( $options ) { @@ -39,7 +43,9 @@ function mu_options( $options ) { } /** - * @deprecated 3.0.0 + * Deprecated functionality for activating a network-only plugin. + * + * @deprecated 3.0.0 Use activate_plugin() * @see activate_plugin() */ function activate_sitewide_plugin() { @@ -48,7 +54,9 @@ function activate_sitewide_plugin() { } /** - * @deprecated 3.0.0 + * Deprecated functionality for deactivating a network-only plugin. + * + * @deprecated 3.0.0 Use deactivate_sitewide_plugin() * @see deactivate_sitewide_plugin() */ function deactivate_sitewide_plugin( $plugin = false ) { @@ -56,7 +64,9 @@ function deactivate_sitewide_plugin( $plugin = false ) { } /** - * @deprecated 3.0.0 + * Deprecated functionality for determining if the current plugin is network-only. + * + * @deprecated 3.0.0 Use is_network_only_plugin() * @see is_network_only_plugin() */ function is_wpmu_sitewide_plugin( $file ) { @@ -65,7 +75,9 @@ function is_wpmu_sitewide_plugin( $file ) { } /** - * @deprecated 3.4.0 + * Deprecated functionality for getting themes network-enabled themes. + * + * @deprecated 3.4.0 Use WP_Theme::get_allowed_on_network() * @see WP_Theme::get_allowed_on_network() */ function get_site_allowed_themes() { @@ -74,7 +86,9 @@ function get_site_allowed_themes() { } /** - * @deprecated 3.4.0 + * Deprecated functionality for getting themes allowed on a specific site. + * + * @deprecated 3.4.0 Use WP_Theme::get_allowed_on_site() * @see WP_Theme::get_allowed_on_site() */ function wpmu_get_blog_allowedthemes( $blog_id = 0 ) { @@ -83,6 +97,8 @@ function wpmu_get_blog_allowedthemes( $blog_id = 0 ) { } /** - * @deprecated + * Deprecated functionality for determining whether a file is deprecated. + * + * @deprecated 3.5.0 */ -function ms_deprecated_blogs_file() {} \ No newline at end of file +function ms_deprecated_blogs_file() {}