From f668df3cec35bb5ff35cf590c01b2b269f454be7 Mon Sep 17 00:00:00 2001 From: audrasjb Date: Thu, 24 Aug 2023 09:01:16 +0000 Subject: [PATCH] Docs: Wrap inline `@see` tags in curly braces. Props costdev, mukesh27. Fixes #58858. See #58833. Built from https://develop.svn.wordpress.org/trunk@56434 git-svn-id: http://core.svn.wordpress.org/trunk@55946 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/includes/class-language-pack-upgrader.php | 2 +- wp-admin/includes/class-walker-category-checklist.php | 8 ++++---- wp-admin/includes/file.php | 6 +++--- wp-includes/category.php | 2 +- wp-includes/class-wp-query.php | 2 +- .../customize/class-wp-customize-themes-section.php | 4 ++-- wp-includes/media.php | 6 +++--- wp-includes/ms-site.php | 2 +- wp-includes/query.php | 2 +- wp-includes/version.php | 2 +- wp-settings.php | 2 +- 11 files changed, 19 insertions(+), 19 deletions(-) diff --git a/wp-admin/includes/class-language-pack-upgrader.php b/wp-admin/includes/class-language-pack-upgrader.php index 0309570031..adeac200d4 100644 --- a/wp-admin/includes/class-language-pack-upgrader.php +++ b/wp-admin/includes/class-language-pack-upgrader.php @@ -153,7 +153,7 @@ class Language_Pack_Upgrader extends WP_Upgrader { * * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass. * - * @param object[] $language_updates Optional. Array of language packs to update. @see wp_get_translation_updates(). + * @param object[] $language_updates Optional. Array of language packs to update. See {@see wp_get_translation_updates()}. * Default empty array. * @param array $args { * Other arguments for upgrading multiple language packs. Default empty array. diff --git a/wp-admin/includes/class-walker-category-checklist.php b/wp-admin/includes/class-walker-category-checklist.php index b86ba23a2b..1deb3f9206 100644 --- a/wp-admin/includes/class-walker-category-checklist.php +++ b/wp-admin/includes/class-walker-category-checklist.php @@ -32,7 +32,7 @@ class Walker_Category_Checklist extends Walker { * * @param string $output Used to append additional content (passed by reference). * @param int $depth Depth of category. Used for tab indentation. - * @param array $args An array of arguments. @see wp_terms_checklist() + * @param array $args An array of arguments. See {@see wp_terms_checklist()}. */ public function start_lvl( &$output, $depth = 0, $args = array() ) { $indent = str_repeat( "\t", $depth ); @@ -48,7 +48,7 @@ class Walker_Category_Checklist extends Walker { * * @param string $output Used to append additional content (passed by reference). * @param int $depth Depth of category. Used for tab indentation. - * @param array $args An array of arguments. @see wp_terms_checklist() + * @param array $args An array of arguments. See {@see wp_terms_checklist()}. */ public function end_lvl( &$output, $depth = 0, $args = array() ) { $indent = str_repeat( "\t", $depth ); @@ -67,7 +67,7 @@ class Walker_Category_Checklist extends Walker { * @param string $output Used to append additional content (passed by reference). * @param WP_Term $data_object The current term object. * @param int $depth Depth of the term in reference to parents. Default 0. - * @param array $args An array of arguments. @see wp_terms_checklist() + * @param array $args An array of arguments. See {@see wp_terms_checklist()}. * @param int $current_object_id Optional. ID of the current term. Default 0. */ public function start_el( &$output, $data_object, $depth = 0, $args = array(), $current_object_id = 0 ) { @@ -130,7 +130,7 @@ class Walker_Category_Checklist extends Walker { * @param string $output Used to append additional content (passed by reference). * @param WP_Term $data_object The current term object. * @param int $depth Depth of the term in reference to parents. Default 0. - * @param array $args An array of arguments. @see wp_terms_checklist() + * @param array $args An array of arguments. See {@see wp_terms_checklist()}. */ public function end_el( &$output, $data_object, $depth = 0, $args = array() ) { $output .= "\n"; diff --git a/wp-admin/includes/file.php b/wp-admin/includes/file.php index b9f58b32a7..94777598e8 100644 --- a/wp-admin/includes/file.php +++ b/wp-admin/includes/file.php @@ -777,9 +777,9 @@ function validate_file_to_edit( $file, $allowed_files = array() ) { * An array of override parameters for this file, or boolean false if none are provided. * * @type callable $upload_error_handler Function to call when there is an error during the upload process. - * @see wp_handle_upload_error(). + * See {@see wp_handle_upload_error()}. * @type callable $unique_filename_callback Function to call when determining a unique file name for the file. - * @see wp_unique_filename(). + * See {@see wp_unique_filename()}. * @type string[] $upload_error_strings The strings that describe the error indicated in * `$_FILES[{form field}]['error']`. * @type bool $test_form Whether to test that the `$_POST['action']` parameter is as expected. @@ -845,7 +845,7 @@ function _wp_handle_upload( &$file, $overrides, $time, $action ) { * @since 5.7.0 * * @param array|false $overrides An array of override parameters for this file. Boolean false if none are - * provided. @see _wp_handle_upload(). + * provided. See {@see _wp_handle_upload()}. * @param array $file { * Reference to a single element from `$_FILES`. * diff --git a/wp-includes/category.php b/wp-includes/category.php index a97c2c963a..5dc35cf6b5 100644 --- a/wp-includes/category.php +++ b/wp-includes/category.php @@ -307,7 +307,7 @@ function get_tags( $args = '' ) { * * @param WP_Term[]|int|WP_Error $tags Array of 'post_tag' term objects, a count thereof, * or WP_Error if any of the taxonomies do not exist. - * @param array $args An array of arguments. @see get_terms() + * @param array $args An array of arguments. See {@see get_terms()}. */ $tags = apply_filters( 'get_tags', $tags, $args ); } diff --git a/wp-includes/class-wp-query.php b/wp-includes/class-wp-query.php index 4e1ce2e425..0aae0379fe 100644 --- a/wp-includes/class-wp-query.php +++ b/wp-includes/class-wp-query.php @@ -4312,7 +4312,7 @@ class WP_Query { * If you set a static page for the front page of your site, this function will return * true when viewing that page. * - * Otherwise the same as @see WP_Query::is_home() + * Otherwise the same as {@see WP_Query::is_home()}. * * @since 3.1.0 * diff --git a/wp-includes/customize/class-wp-customize-themes-section.php b/wp-includes/customize/class-wp-customize-themes-section.php index 81503f080f..f50f56153b 100644 --- a/wp-includes/customize/class-wp-customize-themes-section.php +++ b/wp-includes/customize/class-wp-customize-themes-section.php @@ -115,7 +115,7 @@ class WP_Customize_Themes_Section extends WP_Customize_Section { * Render the filter bar portion of a themes section as a JS template. * * The template is only rendered by PHP once, so all actions are prepared at once on the server side. - * The filter bar container is rendered by @see `render_template()`. + * The filter bar container is rendered by {@see render_template()}. * * @since 4.9.0 */ @@ -179,7 +179,7 @@ class WP_Customize_Themes_Section extends WP_Customize_Section { /** * Render the filter drawer portion of a themes section as a JS template. * - * The filter bar container is rendered by @see `render_template()`. + * The filter bar container is rendered by {@see render_template()}. * * @since 4.9.0 */ diff --git a/wp-includes/media.php b/wp-includes/media.php index dca22d3d37..aeedcc22a9 100644 --- a/wp-includes/media.php +++ b/wp-includes/media.php @@ -3219,7 +3219,7 @@ function wp_audio_shortcode( $attr, $content = '' ) { * @since 3.6.0 * * @param string $html Empty variable to be replaced with shortcode markup. - * @param array $attr Attributes of the shortcode. @see wp_audio_shortcode() + * @param array $attr Attributes of the shortcode. See {@see wp_audio_shortcode()}. * @param string $content Shortcode content. * @param int $instance Unique numeric ID of this audio shortcode instance. */ @@ -3441,7 +3441,7 @@ function wp_video_shortcode( $attr, $content = '' ) { * @see wp_video_shortcode() * * @param string $html Empty variable to be replaced with shortcode markup. - * @param array $attr Attributes of the shortcode. @see wp_video_shortcode() + * @param array $attr Attributes of the shortcode. See {@see wp_video_shortcode()}. * @param string $content Video shortcode content. * @param int $instance Unique numeric ID of this video shortcode instance. */ @@ -4513,7 +4513,7 @@ function wp_prepare_attachment_for_js( $attachment ) { * * @since 3.5.0 * - * @param array $response Array of prepared attachment data. @see wp_prepare_attachment_for_js(). + * @param array $response Array of prepared attachment data. See {@see wp_prepare_attachment_for_js()}. * @param WP_Post $attachment Attachment object. * @param array|false $meta Array of attachment meta data, or false if there is none. */ diff --git a/wp-includes/ms-site.php b/wp-includes/ms-site.php index 256932be65..40321d57e0 100644 --- a/wp-includes/ms-site.php +++ b/wp-includes/ms-site.php @@ -844,7 +844,7 @@ function wp_uninitialize_site( $site_id ) { * * @since MU (3.0.0) * - * @param string $basedir Uploads path without subdirectory. @see wp_upload_dir() + * @param string $basedir Uploads path without subdirectory. See {@see wp_upload_dir()}. * @param int $site_id The site ID. */ $dir = apply_filters( 'wpmu_delete_blog_upload_dir', $uploads['basedir'], $site->id ); diff --git a/wp-includes/query.php b/wp-includes/query.php index c92257ee0d..94c6453b66 100644 --- a/wp-includes/query.php +++ b/wp-includes/query.php @@ -451,7 +451,7 @@ function is_comment_feed() { * If you set a static page for the front page of your site, this function will return * true when viewing that page. * - * Otherwise the same as @see is_home() + * Otherwise the same as {@see is_home()}. * * For more information on this and similar theme functions, check out * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ diff --git a/wp-includes/version.php b/wp-includes/version.php index 96999c63b1..c86b49b09c 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -16,7 +16,7 @@ * * @global string $wp_version */ -$wp_version = '6.4-alpha-56433'; +$wp_version = '6.4-alpha-56434'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. diff --git a/wp-settings.php b/wp-settings.php index 2479420742..9760b519a7 100644 --- a/wp-settings.php +++ b/wp-settings.php @@ -522,7 +522,7 @@ do_action( 'sanitize_comment_cookies' ); $GLOBALS['wp_the_query'] = new WP_Query(); /** - * Holds the reference to @see $wp_the_query + * Holds the reference to {@see $wp_the_query}. * Use this global for WordPress queries * * @global WP_Query $wp_query WordPress Query object.