From a714bc03ee8310c91c67d054d05b98daeea23acc Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Fri, 12 May 2023 21:35:21 +0000 Subject: [PATCH] Docs: Various corrections and improvements to inline docs and docblocks. See #57840 Built from https://develop.svn.wordpress.org/trunk@55753 git-svn-id: http://core.svn.wordpress.org/trunk@55265 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-activate.php | 2 +- wp-admin/includes/deprecated.php | 6 +++--- wp-admin/includes/media.php | 3 +++ wp-admin/includes/ms.php | 1 + wp-admin/includes/widgets.php | 2 ++ wp-includes/class-simplepie.php | 2 ++ wp-includes/comment.php | 1 + wp-includes/deprecated.php | 2 +- wp-includes/feed.php | 1 + wp-includes/plugin.php | 1 + wp-includes/version.php | 2 +- 11 files changed, 17 insertions(+), 6 deletions(-) diff --git a/wp-activate.php b/wp-activate.php index e10df22369..728edcf4e3 100644 --- a/wp-activate.php +++ b/wp-activate.php @@ -87,7 +87,7 @@ do_action( 'activate_header' ); */ function do_activate_header() { /** - * Fires before the Site Activation page is loaded. + * Fires within the `` section of the Site Activation page. * * Fires on the {@see 'wp_head'} action. * diff --git a/wp-admin/includes/deprecated.php b/wp-admin/includes/deprecated.php index 33a7d8fef0..04f7208422 100644 --- a/wp-admin/includes/deprecated.php +++ b/wp-admin/includes/deprecated.php @@ -197,7 +197,7 @@ function remove_option_update_handler( $option_group, $option_name, $sanitize_ca * @deprecated 3.0.0 * * @param string $filename -**/ + */ function codepress_get_lang( $filename ) { _deprecated_function( __FUNCTION__, '3.0.0' ); } @@ -207,7 +207,7 @@ function codepress_get_lang( $filename ) { * * @since 2.8.0 * @deprecated 3.0.0 -**/ + */ function codepress_footer_js() { _deprecated_function( __FUNCTION__, '3.0.0' ); } @@ -217,7 +217,7 @@ function codepress_footer_js() { * * @since 2.8.0 * @deprecated 3.0.0 -**/ + */ function use_codepress() { _deprecated_function( __FUNCTION__, '3.0.0' ); } diff --git a/wp-admin/includes/media.php b/wp-admin/includes/media.php index b0b9b051ad..ea3c856782 100644 --- a/wp-admin/includes/media.php +++ b/wp-admin/includes/media.php @@ -254,6 +254,9 @@ function image_add_caption( $html, $id, $caption, $title, $align, $url, $size, $ * * @access private * @since 3.4.0 + * + * @param array $matches Single regex match. + * @return string Cleaned up HTML for caption. */ function _cleanup_image_add_caption( $matches ) { // Remove any line breaks from inside the tags. diff --git a/wp-admin/includes/ms.php b/wp-admin/includes/ms.php index 2e8d38f2b0..ab73a2746e 100644 --- a/wp-admin/includes/ms.php +++ b/wp-admin/includes/ms.php @@ -848,6 +848,7 @@ var tb_pathToImage = "