Make WordPress Core

Changeset 56434


Ignore:
Timestamp:
08/24/2023 08:59:36 AM (11 months ago)
Author:
audrasjb
Message:

Docs: Wrap inline @see tags in curly braces.

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

Location:
trunk/src
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-language-pack-upgrader.php

    r55990 r56434  
    154154     * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
    155155     *
    156      * @param object[] $language_updates Optional. Array of language packs to update. @see wp_get_translation_updates().
     156     * @param object[] $language_updates Optional. Array of language packs to update. See {@see wp_get_translation_updates()}.
    157157     *                                   Default empty array.
    158158     * @param array    $args {
  • trunk/src/wp-admin/includes/class-walker-category-checklist.php

    r51780 r56434  
    3333     * @param string $output Used to append additional content (passed by reference).
    3434     * @param int    $depth  Depth of category. Used for tab indentation.
    35      * @param array  $args   An array of arguments. @see wp_terms_checklist()
     35     * @param array  $args   An array of arguments. See {@see wp_terms_checklist()}.
    3636     */
    3737    public function start_lvl( &$output, $depth = 0, $args = array() ) {
     
    4949     * @param string $output Used to append additional content (passed by reference).
    5050     * @param int    $depth  Depth of category. Used for tab indentation.
    51      * @param array  $args   An array of arguments. @see wp_terms_checklist()
     51     * @param array  $args   An array of arguments. See {@see wp_terms_checklist()}.
    5252     */
    5353    public function end_lvl( &$output, $depth = 0, $args = array() ) {
     
    6868     * @param WP_Term $data_object       The current term object.
    6969     * @param int     $depth             Depth of the term in reference to parents. Default 0.
    70      * @param array   $args              An array of arguments. @see wp_terms_checklist()
     70     * @param array   $args              An array of arguments. See {@see wp_terms_checklist()}.
    7171     * @param int     $current_object_id Optional. ID of the current term. Default 0.
    7272     */
     
    131131     * @param WP_Term $data_object The current term object.
    132132     * @param int     $depth       Depth of the term in reference to parents. Default 0.
    133      * @param array   $args        An array of arguments. @see wp_terms_checklist()
     133     * @param array   $args        An array of arguments. See {@see wp_terms_checklist()}.
    134134     */
    135135    public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {
  • trunk/src/wp-admin/includes/file.php

    r56186 r56434  
    778778 *
    779779 *     @type callable $upload_error_handler     Function to call when there is an error during the upload process.
    780  *                                              @see wp_handle_upload_error().
     780 *                                              See {@see wp_handle_upload_error()}.
    781781 *     @type callable $unique_filename_callback Function to call when determining a unique file name for the file.
    782  *                                              @see wp_unique_filename().
     782 *                                              See {@see wp_unique_filename()}.
    783783 *     @type string[] $upload_error_strings     The strings that describe the error indicated in
    784784 *                                              `$_FILES[{form field}]['error']`.
     
    846846     *
    847847     * @param array|false $overrides An array of override parameters for this file. Boolean false if none are
    848      *                               provided. @see _wp_handle_upload().
     848     *                               provided. See {@see _wp_handle_upload()}.
    849849     * @param array       $file      {
    850850     *     Reference to a single element from `$_FILES`.
  • trunk/src/wp-includes/category.php

    r55880 r56434  
    308308         * @param WP_Term[]|int|WP_Error $tags Array of 'post_tag' term objects, a count thereof,
    309309         *                                     or WP_Error if any of the taxonomies do not exist.
    310          * @param array                  $args An array of arguments. @see get_terms()
     310         * @param array                  $args An array of arguments. See {@see get_terms()}.
    311311         */
    312312        $tags = apply_filters( 'get_tags', $tags, $args );
  • trunk/src/wp-includes/class-wp-query.php

    r56178 r56434  
    43134313     * true when viewing that page.
    43144314     *
    4315      * Otherwise the same as @see WP_Query::is_home()
     4315     * Otherwise the same as {@see WP_Query::is_home()}.
    43164316     *
    43174317     * @since 3.1.0
  • trunk/src/wp-includes/customize/class-wp-customize-themes-section.php

    r56193 r56434  
    116116     *
    117117     * The template is only rendered by PHP once, so all actions are prepared at once on the server side.
    118      * The filter bar container is rendered by @see `render_template()`.
     118     * The filter bar container is rendered by {@see render_template()}.
    119119     *
    120120     * @since 4.9.0
     
    180180     * Render the filter drawer portion of a themes section as a JS template.
    181181     *
    182      * The filter bar container is rendered by @see `render_template()`.
     182     * The filter bar container is rendered by {@see render_template()}.
    183183     *
    184184     * @since 4.9.0
  • trunk/src/wp-includes/media.php

    r56418 r56434  
    32203220     *
    32213221     * @param string $html     Empty variable to be replaced with shortcode markup.
    3222      * @param array  $attr     Attributes of the shortcode. @see wp_audio_shortcode()
     3222     * @param array  $attr     Attributes of the shortcode. See {@see wp_audio_shortcode()}.
    32233223     * @param string $content  Shortcode content.
    32243224     * @param int    $instance Unique numeric ID of this audio shortcode instance.
     
    34423442     *
    34433443     * @param string $html     Empty variable to be replaced with shortcode markup.
    3444      * @param array  $attr     Attributes of the shortcode. @see wp_video_shortcode()
     3444     * @param array  $attr     Attributes of the shortcode. See {@see wp_video_shortcode()}.
    34453445     * @param string $content  Video shortcode content.
    34463446     * @param int    $instance Unique numeric ID of this video shortcode instance.
     
    45144514     * @since 3.5.0
    45154515     *
    4516      * @param array       $response   Array of prepared attachment data. @see wp_prepare_attachment_for_js().
     4516     * @param array       $response   Array of prepared attachment data. See {@see wp_prepare_attachment_for_js()}.
    45174517     * @param WP_Post     $attachment Attachment object.
    45184518     * @param array|false $meta       Array of attachment meta data, or false if there is none.
  • trunk/src/wp-includes/ms-site.php

    r56192 r56434  
    845845     * @since MU (3.0.0)
    846846     *
    847      * @param string $basedir Uploads path without subdirectory. @see wp_upload_dir()
     847     * @param string $basedir Uploads path without subdirectory. See {@see wp_upload_dir()}.
    848848     * @param int    $site_id The site ID.
    849849     */
  • trunk/src/wp-includes/query.php

    r56192 r56434  
    452452 * true when viewing that page.
    453453 *
    454  * Otherwise the same as @see is_home()
     454 * Otherwise the same as {@see is_home()}.
    455455 *
    456456 * For more information on this and similar theme functions, check out
  • trunk/src/wp-settings.php

    r56296 r56434  
    523523
    524524/**
    525  * Holds the reference to @see $wp_the_query
     525 * Holds the reference to {@see $wp_the_query}.
    526526 * Use this global for WordPress queries
    527527 *
Note: See TracChangeset for help on using the changeset viewer.