Changeset 56434

Timestamp:

08/24/2023 08:59:36 AM (3 years ago)

Author:

audrasjb

Message:

Docs: Wrap inline @see tags in curly braces.

Props costdev, mukesh27.
Fixes #58858.
See #58833.

Location:

trunk/src

Files:

• wp-admin/includes/class-language-pack-upgrader.php (modified) (1 diff)
• wp-admin/includes/class-walker-category-checklist.php (modified) (4 diffs)
• wp-admin/includes/file.php (modified) (2 diffs)
• wp-includes/category.php (modified) (1 diff)
• wp-includes/class-wp-query.php (modified) (1 diff)
• wp-includes/customize/class-wp-customize-themes-section.php (modified) (2 diffs)
• wp-includes/media.php (modified) (3 diffs)
• wp-includes/ms-site.php (modified) (1 diff)
• wp-includes/query.php (modified) (1 diff)
• wp-settings.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-language-pack-upgrader.php

@@ -154 +154 @@
          * @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 {

trunk/src/wp-admin/includes/class-walker-category-checklist.php

@@ -33 +33 @@
          * @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() ) {
@@ -49 +49 @@
          * @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() ) {
@@ -68 +68 @@
          * @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.
          */
@@ -131 +131 @@
          * @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() ) {

trunk/src/wp-admin/includes/file.php

@@ -778 +778 @@
  *
  *     @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']`.
@@ -846 +846 @@
          *
          * @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`.

trunk/src/wp-includes/category.php

@@ -308 +308 @@
                  * @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 );

trunk/src/wp-includes/class-wp-query.php

@@ -4313 +4313 @@
          * 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

trunk/src/wp-includes/customize/class-wp-customize-themes-section.php

@@ -116 +116 @@
          *
          * 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
@@ -180 +180 @@
          * 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

trunk/src/wp-includes/media.php

@@ -3220 +3220 @@
          *
          * @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.
@@ -3442 +3442 @@
          *
          * @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.
@@ -4514 +4514 @@
          * @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.

trunk/src/wp-includes/ms-site.php

@@ -845 +845 @@
          * @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.
          */

trunk/src/wp-includes/query.php

@@ -452 +452 @@
  * 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

trunk/src/wp-settings.php

@@ -523 +523 @@
 
 /**
- * Holds the reference to @see $wp_the_query
+ * Holds the reference to {@see $wp_the_query}.
  * Use this global for WordPress queries
  *