From d10a86ad1d560715a7282b09f0d15b51843db521 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Sat, 18 Jul 2020 22:09:57 +0000 Subject: [PATCH] Docs: Miscellaneous docblock corrections. See #49572 git-svn-id: https://develop.svn.wordpress.org/trunk@48508 602fd350-edb4-49c9-b593-d223f7449a82 --- .../includes/class-plugin-installer-skin.php | 2 +- .../includes/class-theme-installer-skin.php | 2 +- .../class-wp-privacy-policy-content.php | 2 ++ src/wp-admin/includes/class-wp-screen.php | 4 +++- .../includes/class-wp-upgrader-skin.php | 2 +- src/wp-admin/includes/image.php | 18 +++++++++--------- src/wp-admin/includes/ms.php | 2 +- .../class-wp-recovery-mode-email-service.php | 4 ++-- 8 files changed, 20 insertions(+), 16 deletions(-) diff --git a/src/wp-admin/includes/class-plugin-installer-skin.php b/src/wp-admin/includes/class-plugin-installer-skin.php index 617d021168..23af7d23d7 100644 --- a/src/wp-admin/includes/class-plugin-installer-skin.php +++ b/src/wp-admin/includes/class-plugin-installer-skin.php @@ -62,7 +62,7 @@ class Plugin_Installer_Skin extends WP_Upgrader_Skin { * * @since 5.5.0 * - * @param $wp_error WP_Error. + * @param WP_Error $wp_error WP_Error. * @return bool */ public function hide_process_failed( $wp_error ) { diff --git a/src/wp-admin/includes/class-theme-installer-skin.php b/src/wp-admin/includes/class-theme-installer-skin.php index a90fe808a4..8df9a36f65 100644 --- a/src/wp-admin/includes/class-theme-installer-skin.php +++ b/src/wp-admin/includes/class-theme-installer-skin.php @@ -62,7 +62,7 @@ class Theme_Installer_Skin extends WP_Upgrader_Skin { * * @since 5.5.0 * - * @param $wp_error WP_Error. + * @param WP_Error $wp_error WP_Error. * @return bool */ public function hide_process_failed( $wp_error ) { diff --git a/src/wp-admin/includes/class-wp-privacy-policy-content.php b/src/wp-admin/includes/class-wp-privacy-policy-content.php index abe5a9ef49..c3f6873e1b 100644 --- a/src/wp-admin/includes/class-wp-privacy-policy-content.php +++ b/src/wp-admin/includes/class-wp-privacy-policy-content.php @@ -155,6 +155,8 @@ final class WP_Privacy_Policy_Content { * * @since 4.9.6 * @access private + * + * @param int $post_id The ID of the updated post. */ public static function _policy_page_updated( $post_id ) { $policy_page_id = (int) get_option( 'wp_page_for_privacy_policy' ); diff --git a/src/wp-admin/includes/class-wp-screen.php b/src/wp-admin/includes/class-wp-screen.php index 600ffa8411..49e381dfcc 100644 --- a/src/wp-admin/includes/class-wp-screen.php +++ b/src/wp-admin/includes/class-wp-screen.php @@ -1041,7 +1041,9 @@ final class WP_Screen { * @since 3.3.0 * * @param array $options { - * @type bool $wrap Whether the screen-options-wrap div will be included. Defaults to true. + * Options for the tab. + * + * @type bool $wrap Whether the screen-options-wrap div will be included. Defaults to true. * } */ public function render_screen_options( $options = array() ) { diff --git a/src/wp-admin/includes/class-wp-upgrader-skin.php b/src/wp-admin/includes/class-wp-upgrader-skin.php index 26a77ec39a..b88fbadc66 100644 --- a/src/wp-admin/includes/class-wp-upgrader-skin.php +++ b/src/wp-admin/includes/class-wp-upgrader-skin.php @@ -211,7 +211,7 @@ class WP_Upgrader_Skin { * * @since 5.5.0 * - * @param $wp_error WP_Error + * @param WP_Error $wp_error WP_Error * @return bool */ public function hide_process_failed( $wp_error ) { diff --git a/src/wp-admin/includes/image.php b/src/wp-admin/includes/image.php index 697feadf97..127076b6c7 100644 --- a/src/wp-admin/includes/image.php +++ b/src/wp-admin/includes/image.php @@ -11,15 +11,15 @@ * * @since 2.1.0 * - * @param string|int $src The source file or Attachment ID. - * @param int $src_x The start x position to crop from. - * @param int $src_y The start y position to crop from. - * @param int $src_w The width to crop. - * @param int $src_h The height to crop. - * @param int $dst_w The destination width. - * @param int $dst_h The destination height. - * @param int $src_abs Optional. If the source crop points are absolute. - * @param string $dst_file Optional. The destination file to write to. + * @param string|int $src The source file or Attachment ID. + * @param int $src_x The start x position to crop from. + * @param int $src_y The start y position to crop from. + * @param int $src_w The width to crop. + * @param int $src_h The height to crop. + * @param int $dst_w The destination width. + * @param int $dst_h The destination height. + * @param bool $src_abs Optional. If the source crop points are absolute. + * @param string $dst_file Optional. The destination file to write to. * @return string|WP_Error New filepath on success, WP_Error on failure. */ function wp_crop_image( $src, $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h, $src_abs = false, $dst_file = false ) { diff --git a/src/wp-admin/includes/ms.php b/src/wp-admin/includes/ms.php index 6a2efa23b7..ff7df62354 100644 --- a/src/wp-admin/includes/ms.php +++ b/src/wp-admin/includes/ms.php @@ -1018,7 +1018,7 @@ jQuery(document).ready( function($) { * * @since 4.6.0 * - * @param $args { + * @param array $args { * Optional. Array or string of Query parameters. Default empty array. * * @type int $blog_id The site ID. Default is the current site. diff --git a/src/wp-includes/class-wp-recovery-mode-email-service.php b/src/wp-includes/class-wp-recovery-mode-email-service.php index ebf5e050c4..e99712e67b 100644 --- a/src/wp-includes/class-wp-recovery-mode-email-service.php +++ b/src/wp-includes/class-wp-recovery-mode-email-service.php @@ -133,7 +133,7 @@ final class WP_Recovery_Mode_Email_Service { * * @since 5.2.0 * - * @param $message string The Message to include in the email. + * @param string $message The Message to include in the email. */ $support = apply_filters( 'recovery_email_support_info', __( 'Please contact your host for assistance with investigating this issue further.' ) ); @@ -142,7 +142,7 @@ final class WP_Recovery_Mode_Email_Service { * * @since 5.3.0 * - * @param $message array An associated array of debug information. + * @param array $message An associative array of debug information. */ $debug = apply_filters( 'recovery_email_debug_info', $this->get_debug( $extension ) );