WordPress.org
Get WordPress

Make WordPress Core

Changeset 63600


Ignore:
Timestamp:
09/11/2026 10:50:50 AM (10 hours ago)
Author:
afercia
Message:

General: Fix indentation and alignments in JavaScript inline documentation blocks.

Enables the following JSDoc rules:

  • jsdoc/check-alignment
  • jsdoc/check-indentation
  • jsdoc/check-line-alignment
  • jsdoc/require-hyphen-before-param-description -> never

Fixes all the reported violations. Also removes hyphens before descriptions.

Part of the effort to improve JS inline documentation for 7.2.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/13490

Props afercia, mukesh27.
See #66033.

Location:
trunk
Files:
60 edited

Legend:

Unmodified
Added
Removed

  • trunk/.eslintrc-jsdoc.js

    r63598 r63600  
    3737                },
    3838                rules: {
     39                        'jsdoc/check-alignment': 'error',
     40                        'jsdoc/check-indentation': [ 'error', {
     41                                excludeTags: [
     42                                        'deprecated',
     43                                        'example',
     44                                        'param',
     45                                        'property',
     46                                        'return',
     47                                        'since',
     48                                        'todo',
     49                                ],
     50                        } ],
     51                        'jsdoc/check-line-alignment': [ 'error', 'always', {
     52                                tags: [ 'param', 'property' ],
     53                        } ],
    3954                        'jsdoc/check-param-names': 'error',
    4055                        'jsdoc/check-syntax': 'error',
    … …  
    4964                        'jsdoc/check-types': 'error',
    5065                        'jsdoc/require-description': 'error',
     66                        'jsdoc/require-hyphen-before-param-description': [ 'error', 'never' ],
    5167                        'jsdoc/require-jsdoc': 'error',
    5268                        'jsdoc/require-param': [ 'error', {

  • trunk/src/js/_enqueues/admin/application-passwords.js

    r63514 r63600  
    173173         * @since 5.6.0
    174174         *
    175          * @param {jqXHR} xhr The XHR object from the ajax call.
    176          * @param {string} textStatus The string categorizing the ajax request's status.
     175         * @param {jqXHR}  xhr        The XHR object from the ajax call.
     176         * @param {string} textStatus  The string categorizing the ajax request's status.
    177177         * @param {string} errorThrown The HTTP status error text.
    178178         */

  • trunk/src/js/_enqueues/admin/common.js

    r63406 r63600  
    33 */
    44
    5 /* global setUserSetting, ajaxurl, alert, confirm, pagenow */
    6 /* global columns, screenMeta */
    7 
    8 /**
    9  *  Adds common WordPress functionality to the window.
    10  *
    11  *  @param {JQueryStatic} $         The jQuery object.
    12  *  @param {Object}       window    The window object.
    13  *  @param {*}            undefined Unused.
     5/* global setUserSetting, ajaxurl, alert, confirm, pagenow, columns, screenMeta */
     6
     7/**
     8 * Adds common WordPress functionality to the window.
     9 *
     10 * @param {JQueryStatic} $         The jQuery object.
     11 * @param {Object}       window    The window object.
     12 * @param {*}            undefined Unused.
    1413 */
    1514( function( $, window, undefined ) {
    … …  
    569568 *
    570569 * @type {{element: null, toggles: null, page: null, init: screenMeta.init,
    571  *         toggleEvent: screenMeta.toggleEvent, open: screenMeta.open,
    572  *         close: screenMeta.close}}
     570 * toggleEvent: screenMeta.toggleEvent, open: screenMeta.open,
     571 * close: screenMeta.close}}
    573572 *
    574573 * @return {void}
    … …  
    981980                        /*
    982981                         * Show the sub instead of following the link if:
    983                          *      - the submenu is not open.
    984                          *      - the submenu is not shown inline or the menu is not folded.
     982                         * - the submenu is not open.
     983                         * - the submenu is not shown inline or the menu is not folded.
    985984                         */
    986985                        if ( ! $menuItem.hasClass( 'opensub' ) && ( ! $menuItem.hasClass( 'wp-menu-open' ) || $menuItem.width() < 40 ) ) {
    … …  
    14861485         *
    14871486         * @return {void}
    1488          */
     1487         */
    14891488        $('#contextual-help-link, #show-settings-link').on( 'focus.scroll-into-view', function(e){
    14901489                if ( e.target.scrollIntoViewIfNeeded )

  • trunk/src/js/_enqueues/admin/custom-background.js

    r63406 r63600  
    125125                         *
    126126                         * @return {void}
    127                          */
     127                         */
    128128                        frame.on( 'select', function() {
    129129                                // Grab the selected attachment.

  • trunk/src/js/_enqueues/admin/edit-comments.js

    r63514 r63600  
    4343         *
    4444         * @param {jQuery} el The jQuery element to update.
    45          * @param {number} n Number to be put in the element.
     45         * @param {number} n  Number to be put in the element.
    4646         *
    4747         * @return {void}
    … …  
    6969         * @access private
    7070         *
    71          * @param {number} diff The amount to lower or raise the approved count with.
     71         * @param {number} diff          The amount to lower or raise the approved count with.
    7272         * @param {number} commentPostId The ID of the post to be updated.
    7373         *
    … …  
    123123         * @param {string} selector The jQuery selector for elements to update a count
    124124         *                          for.
    125          * @param {number} diff The amount to lower or raise the count with.
     125         * @param {number} diff     The amount to lower or raise the count with.
    126126         *
    127127         * @return {void}
    … …  
    232232         * @access private
    233233         *
    234          * @param {number} diff The amount to lower or raise the pending count with.
     234         * @param {number} diff          The amount to lower or raise the pending count with.
    235235         * @param {number} commentPostId The ID of the post to be updated.
    236236         *
    … …  
    323323         * @access private
    324324         *
    325          * @param {number} total Total number of comments.
    326          * @param {number} time Unix timestamp of response.
    327          * @param {boolean} setConfidentTime Whether to update the last confident time
     325         * @param {number}  total            Total number of comments.
     326         * @param {number}  time            Unix timestamp of response.
     327         * @param {boolean} setConfidentTime Whether to update the last confident time
    328328         *                                   with the given time.
    329329         *
    … …  
    346346         * @access private
    347347         *
    348          * @param {Object} r Ajax response object.
     348         * @param {Object} r        Ajax response object.
    349349         * @param {Object} settings Settings for the wpList object.
    350350         *
    … …  
    399399         * @access private
    400400         *
    401          * @param {Object} settings Settings for the wpList object.
    402          * @param {HTMLElement} list Comments table element.
     401         * @param {Object}      settings Settings for the wpList object.
     402         * @param {HTMLElement} list     Comments table element.
    403403         *
    404404         * @return {Object} The settings object.
    … …  
    472472         * @access private
    473473         *
    474          * @param {Object} r Ajax response object.
     474         * @param {Object} r        Ajax response object.
    475475         * @param {Object} settings Settings for the wpList object.
    476476         *
    … …  
    946946         *
    947947         * @param {number} comment_id The comment ID to open an editor for.
    948          * @param {number} post_id The post ID to open an editor for.
    949          * @param {string} action The action to perform. Either 'edit' or 'replyto'.
     948         * @param {number} post_id    The post ID to open an editor for.
     949         * @param {string} action     The action to perform. Either 'edit' or 'replyto'.
    950950         *
    951951         * @return {boolean} Always false.

  • trunk/src/js/_enqueues/admin/inline-edit-post.js

    r63406 r63600  
    1919 * @type {Object}
    2020 *
    21  * @property {string} type The type of inline editor.
    22  * @property {string} what The prefix before the post ID.
     21 * @property {string}       type The type of inline editor.
     22 * @property {string}       what The prefix before the post ID.
    2323 *
    24  * @param {JQueryStatic} $ The jQuery object.
    25  * @param {wp}           wp The WordPress global object.
     24 * @param    {JQueryStatic} $    The jQuery object.
     25 * @param    {wp}           wp  The WordPress global object.
    2626 *
    2727 */

  • trunk/src/js/_enqueues/admin/inline-edit-tax.js

    r63406 r63600  
    1414 * @namespace inlineEditTax
    1515 *
    16  * @property {string} type The type of inline edit we are currently on.
    17  * @property {string} what The type property with a hash prefixed and a dash
    18  *                         suffixed.
    19  *
    20  * @param {JQueryStatic} $  The jQuery object.
    21  * @param {Object}       wp The WordPress object.
     16 * @property {string}       type The type of inline edit we are currently on.
     17 * @property {string}       what The type property with a hash prefixed and a dash suffixed.
     18 *
     19 * @param    {JQueryStatic} $    The jQuery object.
     20 * @param    {Object}       wp   The WordPress object.
    2221 */
    2322( function( $, wp ) {
    … …  
    118117         * @param {string|HTMLElement} id The ID of the term we want to quick edit or an
    119118         *                                element within the table row or the
    120          * table row itself.
     119         *                                table row itself.
    121120         * @return {boolean} Always returns false.
    122121         */
    … …  
    165164         * @param {string|HTMLElement} id The ID of the term we want to quick edit or an
    166165         *                                element within the table row or the
    167          * table row itself.
     166         *                                table row itself.
    168167         * @return {boolean} Always returns false.
    169168         */

  • trunk/src/js/_enqueues/admin/media.js

    r59187 r63600  
    2525                 *
    2626                 * @param {string} af_name The name of the affected element.
    27                  * @param {string} af_val The value of the affected post element.
     27                 * @param {string} af_val  The value of the affected post element.
    2828                 *
    2929                 * @return {boolean} Always returns false.

  • trunk/src/js/_enqueues/admin/postbox.js

    r63598 r63600  
    354354                 * @memberof postboxes
    355355                 *
    356                  * @param {string} page The page we are currently on.
    357                  * @param {Object} [args={}] The arguments for the postbox initializer.
     356                 * @param {string}   page        The page we are currently on.
     357                 * @param {Object}   [args={}]  The arguments for the postbox initializer.
    358358                 * @param {Function} args.pbshow A callback that is called when a postbox opens.
    359359                 * @param {Function} args.pbhide A callback that is called when a postbox

  • trunk/src/js/_enqueues/admin/tags-box.js

    r50547 r63600  
    220220                 * @memberOf tagBox
    221221                 *
    222                  * @param {Object} el The container HTML element.
    223                  * @param {Object|boolean} a When this is an HTML element the text of that
    224                  *                           element will be used for the new tag.
    225                  * @param {number|boolean} f If this value is not passed then the tag input
    226                  *                           field is focused.
     222                 * @param {Object}         el The container HTML element.
     223                 * @param {Object|boolean} a  When this is an HTML element the text of that
     224                 *                            element will be used for the new tag.
     225                 * @param {number|boolean} f  If this value is not passed then the tag input
     226                 *                            field is focused.
    227227                 *
    228228                 * @return {boolean} Always returns false.
    … …  
    288288                         * @since 2.9.0
    289289                         *
    290                          * @param {number|string} r The response message from the Ajax call.
    291                          * @param {string} stat The status of the Ajax request.
     290                         * @param {number|string} r    The response message from the Ajax call.
     291                         * @param {string}        stat The status of the Ajax request.
    292292                         *
    293293                         * @return {void}

  • trunk/src/js/_enqueues/admin/widgets.js

    r63406 r63600  
    753753 *
    754754 * @type {Object}
    755 */
     755 */
    756756wpWidgets.l10n = wpWidgets.l10n || {
    757757        save: '',

  • trunk/src/js/_enqueues/lib/accordion.js

    r63514 r63600  
    66 * Use the following markup structure for accordion behavior:
    77 *
     8 * @example
     9 * ```html
    810 * <div class="accordion-container">
    911 *      <div class="accordion-section open">
    … …  
    2325 *      </div>
    2426 * </div>
     27 * ```
    2528 *
    2629 * Note that any appropriate tags may be used, as long as the above classes are present.

  • trunk/src/js/_enqueues/lib/admin-bar.js

    r63406 r63600  
    175175         *
    176176         * @param {NodeList} topMenuItems All menu items.
    177          * @param {Event} event The click event.
     177         * @param {Event}    event        The click event.
    178178         */
    179179        function mobileHover( topMenuItems, event ) {
    … …  
    261261         * @since 5.3.1
    262262         *
    263          * @param {HTMLElement} element The HTML element.
     263         * @param {HTMLElement} element   The HTML element.
    264264         * @param {string}      className The class name.
    265265         * @return {boolean} Whether the element has the className.
    … …  
    287287         * @since 5.3.1
    288288         *
    289          * @param {HTMLElement} element The HTML element.
     289         * @param {HTMLElement} element   The HTML element.
    290290         * @param {string}      className The class name.
    291291         */
    … …  
    316316         * @since 5.3.1
    317317         *
    318          * @param {HTMLElement} element The HTML element.
     318         * @param {HTMLElement} element   The HTML element.
    319319         * @param {string}      className The class name.
    320320         */
    … …  
    396396         * @since 5.3.1
    397397         *
    398          * @param {HTMLElement} el Element to get parent.
    399          * @param {string} selector CSS selector to match.
     398         * @param {HTMLElement} el       Element to get parent.
     399         * @param {string}      selector CSS selector to match.
    400400         *
    401401         * @return {HTMLElement|null} The closest matching element or null if not found.

  • trunk/src/js/_enqueues/lib/auth-check.js

    r63514 r63600  
    138138         *
    139139         * - Shows the authentication form popup if user is not logged in.
    140          * - Hides the authentication form popup if it is already visible and user is
    141          *   logged in.
     140         * - Hides the authentication form popup if it is already visible and user is logged in.
    142141         *
    143142         * @ignore
    … …  
    145144         * @since 3.6.0
    146145         *
    147          * @param {Object} e The heartbeat-tick event that has been triggered.
     146         * @param {Object} e    The heartbeat-tick event that has been triggered.
    148147         * @param {Object} data Response data.
    149148         */

  • trunk/src/js/_enqueues/lib/codemirror/htmlhint-kses.js

    r61800 r63600  
    99         *
    1010         * @this {import('htmlhint/types').Rule}
    11          * @param {import('htmlhint').HTMLParser} parser - Parser.
    12          * @param {import('htmlhint').Reporter} reporter - Reporter.
    13          * @param {Record<string, Record<string, boolean>>} options - KSES options.
     11         * @param {import('htmlhint').HTMLParser}           parser  Parser.
     12         * @param {import('htmlhint').Reporter}             reporter Reporter.
     13         * @param {Record<string, Record<string, boolean>>} options KSES options.
    1414         * @return {void}
    1515         */

  • trunk/src/js/_enqueues/lib/codemirror/javascript-lint.js

    r63407 r63600  
    1313 *
    1414 * @typedef {Object} CodeMirrorLintError
    15  * @property {string} message Error message.
    16  * @property {'error'} severity Severity.
    17  * @property {CodeMirror.Position} from From position.
    18  * @property {CodeMirror.Position} to To position.
     15 * @property {string}              message Error message.
     16 * @property {'error'}             severity Severity.
     17 * @property {CodeMirror.Position} from     From position.
     18 * @property {CodeMirror.Position} to       To position.
    1919 */
    2020
    … …  
    2626 *
    2727 * @typedef {Object} SupportedJSHintOptions
    28  * @property {import('espree').Options['ecmaVersion']} [esversion] "This option is used to specify the ECMAScript version to which the code must adhere."
    29  * @property {boolean} [es5] "This option enables syntax first defined in the ECMAScript 5.1 specification. This includes allowing reserved keywords as object properties."
    30  * @property {boolean} [es3] "This option tells JSHint that your code needs to adhere to ECMAScript 3 specification. Use this option if you need your program to be executable in older browsers—such as Internet Explorer 6/7/8/9—and other legacy JavaScript environments."
    31  * @property {boolean} [module] "This option informs JSHint that the input code describes an ECMAScript 6 module. All module code is interpreted as strict mode code."
    32  * @property {'implied'} [strict] "This option requires the code to run in ECMAScript 5's strict mode."
    33  * @property {string} [espreeModuleUrl] The URL to the espree script module.
     28 * @property {import('espree').Options['ecmaVersion']} [esversion]       "This option is used to specify the ECMAScript version to which the code must adhere."
     29 * @property {boolean}                                 [es5]            "This option enables syntax first defined in the ECMAScript 5.1 specification. This includes allowing reserved keywords as object properties."
     30 * @property {boolean}                                 [es3]            "This option tells JSHint that your code needs to adhere to ECMAScript 3 specification. Use this option if you need your program to be executable in older browsers—such as Internet Explorer 6/7/8/9—and other legacy JavaScript environments."
     31 * @property {boolean}                                 [module]          "This option informs JSHint that the input code describes an ECMAScript 6 module. All module code is interpreted as strict mode code."
     32 * @property {'implied'}                               [strict]          "This option requires the code to run in ECMAScript 5's strict mode."
     33 * @property {string}                                  [espreeModuleUrl] The URL to the espree script module.
    3434 */
    3535
    … …  
    3939 * @since 7.0.0
    4040 *
    41  * @param {string} text Source.
     41 * @param {string}                 text    Source.
    4242 * @param {SupportedJSHintOptions} options Linting options.
    4343 * @return {Promise<CodeMirrorLintError[]>} Linting errors.

  • trunk/src/js/_enqueues/lib/color-picker.js

    r63514 r63600  
    7070                                 * @ignore
    7171                                 *
    72                                  * @param {Event} event    The event that's being called.
    73                                  * @param {HTMLElement} ui The HTMLElement containing the color picker.
     72                                 * @param {Event}       event The event that's being called.
     73                                 * @param {HTMLElement} ui    The HTMLElement containing the color picker.
    7474                                 *
    7575                                 * @return {void}
    … …  
    190190                                 * @ignore
    191191                                 *
    192                                  * @param {Event} event    The event that's being called.
    193                                  * @param {HTMLElement} ui The HTMLElement containing the color picker.
     192                                 * @param {Event}       event The event that's being called.
     193                                 * @param {HTMLElement} ui    The HTMLElement containing the color picker.
    194194                                 *
    195195                                 * @return {void}

  • trunk/src/js/_enqueues/lib/cookies.js

    r63406 r63600  
    6464         * 'values_obj' is the JS object that is stored. It is encoded as URI in wpCookies.set().
    6565         *
    66          * @param {string}      name         The name of the cookie.
    67          * @param {Object}      values_obj   The values to store in the cookie.
    68          * @param {number|Date} [expires]    Optional. Expiration time in seconds or a Date object.
    69          * @param {string}      [path]       Optional. The path on the server in which the cookie will be available on.
    70          * @param {string}      [domain]     Optional. The domain that the cookie is available to.
    71          * @param {boolean}     [secure]     Optional. Whether the cookie should only be transmitted over a secure HTTPS connection.
     66         * @param {string}      name       The name of the cookie.
     67         * @param {Object}      values_obj The values to store in the cookie.
     68         * @param {number|Date} [expires]  Optional. Expiration time in seconds or a Date object.
     69         * @param {string}      [path]     Optional. The path on the server in which the cookie will be available on.
     70         * @param {string}      [domain]   Optional. The domain that the cookie is available to.
     71         * @param {boolean}     [secure]   Optional. Whether the cookie should only be transmitted over a secure HTTPS connection.
    7272         */
    7373        setHash: function( name, values_obj, expires, path, domain, secure ) {

  • trunk/src/js/_enqueues/lib/emoji-loader.js

    r63406 r63600  
    5858 * @typedef SessionSupportTests
    5959 * @type {Object}
    60  * @property {number} timestamp
     60 * @property {number}       timestamp
    6161 * @property {SupportTests} supportTests
    6262 */
    … …  
    129129 *
    130130 * @param {CanvasRenderingContext2D} context 2D Context.
    131  * @param {string} set1 Set of Emoji to test.
    132  * @param {string} set2 Set of Emoji to test.
     131 * @param {string}                   set1    Set of Emoji to test.
     132 * @param {string}                   set2    Set of Emoji to test.
    133133 *
    134134 * @return {boolean} True if the two sets render the same.
    … …  
    179179 *
    180180 * @param {CanvasRenderingContext2D} context 2D Context.
    181  * @param {string} emoji Emoji to test.
     181 * @param {string}                   emoji  Emoji to test.
    182182 *
    183183 * @return {boolean} True if the center point is empty.
    … …  
    210210 * @private
    211211 *
    212  * @param {CanvasRenderingContext2D} context 2D Context.
    213  * @param {string} type Whether to test for support of "flag" or "emoji".
    214  * @param {Function} emojiSetsRenderIdentically Reference to emojiSetsRenderIdentically function, needed due to minification.
    215  * @param {Function} emojiRendersEmptyCenterPoint Reference to emojiRendersEmptyCenterPoint function, needed due to minification.
     212 * @param {CanvasRenderingContext2D} context                      2D Context.
     213 * @param {string}                   type                        Whether to test for support of "flag" or "emoji".
     214 * @param {Function}                 emojiSetsRenderIdentically  Reference to emojiSetsRenderIdentically function, needed due to minification.
     215 * @param {Function}                 emojiRendersEmptyCenterPoint Reference to emojiRendersEmptyCenterPoint function, needed due to minification.
    216216 *
    217217 * @return {boolean} True if the browser can render emoji, false if it cannot.
    … …  
    303303 * @private
    304304 *
    305  * @param {string[]} tests Tests.
    306  * @param {Function} browserSupportsEmoji Reference to browserSupportsEmoji function, needed due to minification.
    307  * @param {Function} emojiSetsRenderIdentically Reference to emojiSetsRenderIdentically function, needed due to minification.
     305 * @param {string[]} tests                        Tests.
     306 * @param {Function} browserSupportsEmoji         Reference to browserSupportsEmoji function, needed due to minification.
     307 * @param {Function} emojiSetsRenderIdentically   Reference to emojiSetsRenderIdentically function, needed due to minification.
    308308 * @param {Function} emojiRendersEmptyCenterPoint Reference to emojiRendersEmptyCenterPoint function, needed due to minification.
    309309 *

  • trunk/src/js/_enqueues/lib/image-edit.js

    r63406 r63600  
    308308         * @memberof imageEdit
    309309         *
    310          * @param {Event} event The key or click event.
    311          * @param {HTMLElement} el The current element.
     310         * @param {Event}       event The key or click event.
     311         * @param {HTMLElement} el    The current element.
    312312         *
    313313         * @return {boolean} Always returns false.
    … …  
    439439         * @memberof imageEdit
    440440         *
    441          * @param {number}         postid The current post ID.
    442          * @param {number}         x      Is 0 when it applies the y-axis
    443          *                                and 1 when applicable for the x-axis.
    444          * @param {jQuery}         el     Element.
     441         * @param {number} postid The current post ID.
     442         * @param {number} x      Is 0 when it applies the y-axis
     443         *                        and 1 when applicable for the x-axis.
     444         * @param {jQuery} el     Element.
    445445         *
    446446         * @return {void}
    … …  
    733733         * @memberof imageEdit
    734734         *
    735          * @param {number}  postid  The post ID to get the image from the database.
    736          * @param {string}  nonce    The nonce to verify the request.
     735         * @param {number} postid The post ID to get the image from the database.
     736         * @param {string} nonce  The nonce to verify the request.
    737737         *
    738738         * @return {boolean|void}  If the actions are successfully saved a response message is shown.
    … …  
    802802         * @memberof imageEdit
    803803         *
    804          * @param {number} postid   The post ID for the image.
    805          * @param {string} nonce    The nonce to verify the request.
    806          * @param {Object} view     The image editor view to be used for the editing.
     804         * @param {number} postid The post ID for the image.
     805         * @param {string} nonce  The nonce to verify the request.
     806         * @param {Object} view   The image editor view to be used for the editing.
    807807         *
    808808         * @return {void|promise} Either returns void if the button was already activated
    … …  
    12911291         * @memberof imageEdit
    12921292         *
    1293          * @param {number} postid   The post ID.
    1294          * @param {string} nonce    The nonce.
     1293         * @param {number} postid The post ID.
     1294         * @param {string} nonce  The nonce.
    12951295         *
    12961296         * @return {void|false} Returns false if the undo button is disabled.
    … …  
    14491449         * @memberof imageEdit
    14501450         *
    1451          * @param {number} postid     The post ID.
    1452          * @param {number} n          The ratio to set.
    1453          * @param {jQuery} el         The element containing the values.
     1451         * @param {number} postid The post ID.
     1452         * @param {number} n      The ratio to set.
     1453         * @param {jQuery} el     The element containing the values.
    14541454         *
    14551455         * @return {void}

  • trunk/src/js/_enqueues/lib/lists.js

    r63598 r63600  
    227227         * data[3] - Hex color to be used in this request. If data[0] is 'dim', dim class.
    228228         * data[4] - Additional arguments in query syntax that are added to the request. Example: 'post_id=1234'.
    229          *           If data[0] is 'dim', dim add color.
     229         * If data[0] is 'dim', dim add color.
    230230         * data[5] - Only available if data[0] is 'dim', dim delete color.
    231231         * data[6] - Only available if data[0] is 'dim', additional arguments in query syntax that are added to the request.

  • trunk/src/js/_enqueues/lib/pointer.js

    r63407 r63600  
    7575                 *
    7676                 * - `document`     will transfer the pointer to the body of the new document
    77                  *                  specified by the value.
     77                 * specified by the value.
    7878                 * - `pointerClass` will change the class of the pointer element.
    7979                 * - `position`     will reposition the pointer.

  • trunk/src/js/_enqueues/lib/quicktags.js

    r63556 r63600  
    334334         *
    335335         * Minimum required to add a button that calls an external function:
    336          *     QTags.addButton( 'my_id', 'my button', my_callback );
    337          *     function my_callback() { alert('yeah!'); }
     336         * QTags.addButton( 'my_id', 'my button', my_callback );
     337         * function my_callback() { alert('yeah!'); }
    338338         *
    339339         * Minimum required to add a button that inserts a tag:
    340          *     QTags.addButton( 'my_id', 'my button', '<span>', '</span>' );
    341          *     QTags.addButton( 'my_id2', 'my button', '<br />' );
     340         * QTags.addButton( 'my_id', 'my button', '<span>', '</span>' );
     341         * QTags.addButton( 'my_id2', 'my button', '<br />' );
    342342         *
    343343         * @param {string}          id           Required. Button HTML ID

  • trunk/src/js/_enqueues/lib/user-suggest.js

    r50547 r63600  
    3535                 * Optional data-attributes:
    3636                 * - data-autocomplete-type (add, search)
    37                  *   The action that is going to be performed: search for existing users
    38                  *   or add a new one. Default: add
     37                 * The action that is going to be performed: search for existing users
     38                 * or add a new one. Default: add
    3939                 * - data-autocomplete-field (user_login, user_email)
    40                  *   The field that is returned as the value for the suggestion.
    41                  *   Default: user_login
     40                 * The field that is returned as the value for the suggestion.
     41                 * Default: user_login
    4242                 *
    4343                 * @see wp-admin/includes/admin-actions.php:wp_ajax_autocomplete_user()

  • trunk/src/js/_enqueues/wp/api.js

    r63598 r63600  
    207207         * Extract a route part based on negative index.
    208208         *
    209          * @param {string}   route          The endpoint route.
    210          * @param {number}   part           The number of parts from the end of the route to retrieve. Default 1.
     209         * @param {string}  route           The endpoint route.
     210         * @param {number}  part            The number of parts from the end of the route to retrieve. Default 1.
    211211         *                                  Example route `/a/b/c`: part 1 is `c`, part 2 is `b`, part 3 is `a`.
    212212         * @param {string}  [versionString] Version string, defaults to `wp.api.versionString`.
    … …  
    314314         * @param {Backbone Model} model          The model to attach helpers and mixins to.
    315315         * @param {string}         modelClassName The classname of the constructed model.
    316          * @param {Object}             loadingObjects An object containing the models and collections we are building.
     316         * @param {Object}         loadingObjects An object containing the models and collections we are building.
    317317         * @return {undefined} No return value.
    318318         */
    … …  
    859859
    860860                                /**
    861                                 * Types that don't support trashing require passing ?force=true to delete.
    862                                 *
    863                                 */
     861                                 * Types that don't support trashing require passing ?force=true to delete.
     862                                 */
    864863                                if ( -1 === _.indexOf( trashableTypes, this.name ) ) {
    865864                                        this.requireForceForDelete = true;

  • trunk/src/js/_enqueues/wp/backbone.js

    r57987 r63600  
    285285                 *
    286286                 * @return {wp.Backbone.Subviews} The current Subviews instance.
    287                 */
     287                 */
    288288                render: function() {
    289289                        var options = {
    … …  
    315315                 *
    316316                 * @return {wp.Backbone.Subviews} The current Subviews instance.
    317                 */
     317                 */
    318318                remove: function( options ) {
    319319                        if ( ! options || ! options.silent ) {
    … …  
    339339                 *
    340340                 * @param {string} $target Selector where to put the elements.
    341                  * @param {*} els HTML or elements to put into the selector's HTML.
     341                 * @param {*}      els    HTML or elements to put into the selector's HTML.
    342342                 *
    343343                 * @return {wp.Backbone.Subviews} The current Subviews instance.

  • trunk/src/js/_enqueues/wp/code-editor.js

    r63514 r63600  
    2020/**
    2121 * @typedef {Object} CodeMirrorState
    22  * @property {boolean} [completionActive] - Whether completion is active.
    23  * @property {boolean} [focused] - Whether the editor is focused.
     22 * @property {boolean} [completionActive] Whether completion is active.
     23 * @property {boolean} [focused]         Whether the editor is focused.
    2424 */
    2525
    2626/**
    2727 * @typedef {import('codemirror').EditorFromTextArea & {
    28  *   options: import('codemirror').EditorConfiguration,
    29  *   performLint?: () => void,
    30  *   showHint?: (options: import('codemirror').ShowHintOptions) => void,
    31  *   state: CodeMirrorState
     28 *      options: import('codemirror').EditorConfiguration,
     29 *      performLint?: () => void,
     30 *      showHint?: (options: import('codemirror').ShowHintOptions) => void,
     31 *      state: CodeMirrorState
    3232 * }} CodeMirrorEditor
    3333 */
    … …  
    3535/**
    3636 * @typedef {Object} LintAnnotation
    37  * @property {string} message - Message.
    38  * @property {'error'|'warning'} severity - Severity.
    39  * @property {import('codemirror').Position} from - From position.
    40  * @property {import('codemirror').Position} to - To position.
     37 * @property {string}                        message Message.
     38 * @property {'error'|'warning'}             severity Severity.
     39 * @property {import('codemirror').Position} from     From position.
     40 * @property {import('codemirror').Position} to       To position.
    4141 */
    4242
    4343/**
    4444 * @typedef {Object} CodeMirrorTokenState
    45  * @property {Object} [htmlState] - HTML state.
    46  * @property {string} [htmlState.tagName] - Tag name.
    47  * @property {CodeMirrorTokenState} [curState] - Current state.
     45 * @property {Object}               [htmlState]        HTML state.
     46 * @property {string}               [htmlState.tagName] Tag name.
     47 * @property {CodeMirrorTokenState} [curState]         Current state.
    4848 */
    4949
    5050/**
    5151 * @typedef {import('codemirror').EditorConfiguration & {
    52  *   lint?: boolean | CombinedLintOptions,
    53  *   autoCloseBrackets?: boolean,
    54  *   matchBrackets?: boolean,
    55  *   continueComments?: boolean,
    56  *   styleActiveLine?: boolean
     52 *      lint?: boolean | CombinedLintOptions,
     53 *      autoCloseBrackets?: boolean,
     54 *      matchBrackets?: boolean,
     55 *      continueComments?: boolean,
     56 *      styleActiveLine?: boolean
    5757 * }} CodeMirrorSettings
    5858 */
    … …  
    6060/**
    6161 * @typedef {Object} CSSLintRules
    62  * @property {boolean} [errors] - Errors.
    63  * @property {boolean} [box-model] - Box model rules.
    64  * @property {boolean} [display-property-grouping] - Display property grouping rules.
    65  * @property {boolean} [duplicate-properties] - Duplicate properties rules.
    66  * @property {boolean} [known-properties] - Known properties rules.
    67  * @property {boolean} [outline-none] - Outline none rules.
     62 * @property {boolean} [errors]                   Errors.
     63 * @property {boolean} [box-model]                 Box model rules.
     64 * @property {boolean} [display-property-grouping] Display property grouping rules.
     65 * @property {boolean} [duplicate-properties]     Duplicate properties rules.
     66 * @property {boolean} [known-properties]         Known properties rules.
     67 * @property {boolean} [outline-none]             Outline none rules.
    6868 */
    6969
    7070/**
    7171 * @typedef {Object} JSHintRules
    72  * @property {number} [esversion] - ECMAScript version.
    73  * @property {boolean} [module] - Whether to use modules.
    74  * @property {boolean} [boss] - Whether to allow assignments in control expressions.
    75  * @property {boolean} [curly] - Whether to require curly braces.
    76  * @property {boolean} [eqeqeq] - Whether to require === and !==.
    77  * @property {boolean} [eqnull] - Whether to allow == null.
    78  * @property {boolean} [expr] - Whether to allow expressions.
    79  * @property {boolean} [immed] - Whether to require immediate function invocation.
    80  * @property {boolean} [noarg] - Whether to prohibit arguments.caller/callee.
    81  * @property {boolean} [nonbsp] - Whether to prohibit non-breaking spaces.
    82  * @property {string} [quotmark] - Quote mark preference.
    83  * @property {boolean} [undef] - Whether to prohibit undefined variables.
    84  * @property {boolean} [unused] - Whether to prohibit unused variables.
    85  * @property {boolean} [browser] - Whether to enable browser globals.
    86  * @property {Record<string, boolean>} [globals] - Global variables.
     72 * @property {number}                  [esversion] ECMAScript version.
     73 * @property {boolean}                 [module]    Whether to use modules.
     74 * @property {boolean}                 [boss]      Whether to allow assignments in control expressions.
     75 * @property {boolean}                 [curly]    Whether to require curly braces.
     76 * @property {boolean}                 [eqeqeq]    Whether to require === and !==.
     77 * @property {boolean}                 [eqnull]    Whether to allow == null.
     78 * @property {boolean}                 [expr]      Whether to allow expressions.
     79 * @property {boolean}                 [immed]    Whether to require immediate function invocation.
     80 * @property {boolean}                 [noarg]    Whether to prohibit arguments.caller/callee.
     81 * @property {boolean}                 [nonbsp]    Whether to prohibit non-breaking spaces.
     82 * @property {string}                  [quotmark] Quote mark preference.
     83 * @property {boolean}                 [undef]    Whether to prohibit undefined variables.
     84 * @property {boolean}                 [unused]    Whether to prohibit unused variables.
     85 * @property {boolean}                 [browser]  Whether to enable browser globals.
     86 * @property {Record<string, boolean>} [globals]   Global variables.
    8787 */
    8888
    8989/**
    9090 * @typedef {Object} HTMLHintRules
    91  * @property {boolean} [tagname-lowercase] - Tag name lowercase rules.
    92  * @property {boolean} [attr-lowercase] - Attribute lowercase rules.
    93  * @property {boolean} [attr-value-double-quotes] - Attribute value double quotes rules.
    94  * @property {boolean} [doctype-first] - Doctype first rules.
    95  * @property {boolean} [tag-pair] - Tag pair rules.
    96  * @property {boolean} [spec-char-escape] - Spec char escape rules.
    97  * @property {boolean} [id-unique] - ID unique rules.
    98  * @property {boolean} [src-not-empty] - Src not empty rules.
    99  * @property {boolean} [attr-no-duplication] - Attribute no duplication rules.
    100  * @property {boolean} [alt-require] - Alt require rules.
    101  * @property {string} [space-tab-mixed-disabled] - Space tab mixed disabled rules.
    102  * @property {boolean} [attr-unsafe-chars] - Attribute unsafe chars rules.
    103  * @property {JSHintRules} [jshint] - JSHint rules.
    104  * @property {CSSLintRules} [csslint] - CSSLint rules.
     91 * @property {boolean}      [tagname-lowercase]        Tag name lowercase rules.
     92 * @property {boolean}      [attr-lowercase]          Attribute lowercase rules.
     93 * @property {boolean}      [attr-value-double-quotes] Attribute value double quotes rules.
     94 * @property {boolean}      [doctype-first]            Doctype first rules.
     95 * @property {boolean}      [tag-pair]                Tag pair rules.
     96 * @property {boolean}      [spec-char-escape]        Spec char escape rules.
     97 * @property {boolean}      [id-unique]                ID unique rules.
     98 * @property {boolean}      [src-not-empty]            Src not empty rules.
     99 * @property {boolean}      [attr-no-duplication]      Attribute no duplication rules.
     100 * @property {boolean}      [alt-require]              Alt require rules.
     101 * @property {string}       [space-tab-mixed-disabled] Space tab mixed disabled rules.
     102 * @property {boolean}      [attr-unsafe-chars]        Attribute unsafe chars rules.
     103 * @property {JSHintRules}  [jshint]                  JSHint rules.
     104 * @property {CSSLintRules} [csslint]                 CSSLint rules.
    105105 */
    106106
    … …  
    110110 * @typedef {Object} CodeEditorSettings
    111111 *
    112  * @property {CodeMirrorSettings} [codemirror] - CodeMirror settings.
    113  * @property {CSSLintRules} [csslint] - CSSLint rules.
    114  * @property {JSHintRules} [jshint] - JSHint rules.
    115  * @property {HTMLHintRules} [htmlhint] - HTMLHint rules.
     112 * @property {CodeMirrorSettings}                                                                                                                     [codemirror]            CodeMirror settings.
     113 * @property {CSSLintRules}                                                                                                                           [csslint]              CSSLint rules.
     114 * @property {JSHintRules}                                                                                                                            [jshint]                JSHint rules.
     115 * @property {HTMLHintRules}                                                                                                                          [htmlhint]              HTMLHint rules.
    116116 *
    117  * @property {(codemirror: CodeMirrorEditor, event: KeyboardEvent|JQuery.KeyDownEvent) => void} [onTabNext] - Callback to handle tabbing to the next tabbable element.
    118  * @property {(codemirror: CodeMirrorEditor, event: KeyboardEvent|JQuery.KeyDownEvent) => void} [onTabPrevious] - Callback to handle tabbing to the previous tabbable element.
    119  * @property {(errorAnnotations: LintAnnotation[], annotations: LintAnnotation[], annotationsSorted: LintAnnotation[], cm: CodeMirrorEditor) => void} [onChangeLintingErrors] - Callback for when the linting errors have changed.
    120  * @property {(errorAnnotations: LintAnnotation[], editor: CodeMirrorEditor) => void} [onUpdateErrorNotice] - Callback for when error notice should be displayed.
     117 * @property {(codemirror: CodeMirrorEditor, event: KeyboardEvent|JQuery.KeyDownEvent) => void}                                                       [onTabNext]            Callback to handle tabbing to the next tabbable element.
     118 * @property {(codemirror: CodeMirrorEditor, event: KeyboardEvent|JQuery.KeyDownEvent) => void}                                                       [onTabPrevious]        Callback to handle tabbing to the previous tabbable element.
     119 * @property {(errorAnnotations: LintAnnotation[], annotations: LintAnnotation[], annotationsSorted: LintAnnotation[], cm: CodeMirrorEditor) => void} [onChangeLintingErrors] Callback for when the linting errors have changed.
     120 * @property {(errorAnnotations: LintAnnotation[], editor: CodeMirrorEditor) => void}                                                                 [onUpdateErrorNotice]  Callback for when error notice should be displayed.
    121121 */
    122122
    … …  
    127127/**
    128128 * @typedef {Object} CodeEditorInstance
    129  * @property {CodeEditorSettings} settings - The code editor settings.
    130  * @property {CodeMirrorEditor} codemirror - The CodeMirror instance.
    131  * @property {() => void} updateErrorNotice - Force update the error notice.
     129 * @property {CodeEditorSettings} settings         The code editor settings.
     130 * @property {CodeMirrorEditor}   codemirror        The CodeMirror instance.
     131 * @property {() => void}         updateErrorNotice Force update the error notice.
    132132 */
    133133
    134134/**
    135135 * @typedef {Object} WpCodeEditor
    136  * @property {CodeEditorSettings} defaultSettings - Default settings.
    137  * @property {(textarea: string|JQuery|Element, settings?: CodeEditorSettings) => CodeEditorInstance} initialize - Initialize.
     136 * @property {CodeEditorSettings}                                                                     defaultSettings Default settings.
     137 * @property {(textarea: string|JQuery|Element, settings?: CodeEditorSettings) => CodeEditorInstance} initialize     Initialize.
    138138 */
    139139
    … …  
    167167         * Configures linting.
    168168         *
    169          * @param {CodeEditorSettings} settings - Code editor settings.
     169         * @param {CodeEditorSettings} settings Code editor settings.
    170170         *
    171171         * @return {LintingController} Linting controller.
    … …  
    181181                 * Call the onUpdateErrorNotice if there are new errors to show.
    182182                 *
    183                  * @param {import('codemirror').Editor} editor - Editor.
     183                 * @param {import('codemirror').Editor} editor Editor.
    184184                 * @return {void}
    185185                 */
    … …  
    238238                                 * Wraps the onUpdateLinting event to filter errors, detect state changes, and manage error notice visibility.
    239239                                 *
    240                                  * @param {LintAnnotation[]} annotations - Annotations.
    241                                  * @param {LintAnnotation[]} annotationsSorted - Sorted annotations.
    242                                  * @param {CodeMirrorEditor} cm - Editor.
     240                                 * @param {LintAnnotation[]} annotations       Annotations.
     241                                 * @param {LintAnnotation[]} annotationsSorted Sorted annotations.
     242                                 * @param {CodeMirrorEditor} cm               Editor.
    243243                                 */
    244244                                return function( annotations, annotationsSorted, cm ) {
    … …  
    282282                         * Initializes the CodeMirror editor.
    283283                         *
    284                          * @param {CodeMirrorEditor} editor - Editor instance.
     284                         * @param {CodeMirrorEditor} editor Editor instance.
    285285                         * @return {void}
    286286                         */
    … …  
    350350                        },
    351351                        /**
    352                          * @param {CodeMirrorEditor} editor - Editor instance.
     352                         * @param {CodeMirrorEditor} editor Editor instance.
    353353                         * @return {void}
    354354                         */
    … …  
    360360         * Configure tabbing.
    361361         *
    362          * @param {CodeMirrorEditor} codemirror - Editor.
    363          * @param {CodeEditorSettings} settings - Code editor settings.
     362         * @param {CodeMirrorEditor}   codemirror Editor.
     363         * @param {CodeEditorSettings} settings   Code editor settings.
    364364         *
    365365         * @return {void}
    … …  
    400400        /**
    401401         * @typedef {Object} LintingController
    402          * @property {() => CombinedLintOptions|false} getLintOptions - Get lint options.
    403          * @property {(editor: CodeMirrorEditor) => void} init - Initialize.
    404          * @property {(editor: import('codemirror').Editor) => void} updateErrorNotice - Update error notice.
     402         * @property {() => CombinedLintOptions|false}               getLintOptions    Get lint options.
     403         * @property {(editor: CodeMirrorEditor) => void}            init              Initialize.
     404         * @property {(editor: import('codemirror').Editor) => void} updateErrorNotice Update error notice.
    405405         */
    406406
    … …  
    410410         * @since 4.9.0
    411411         *
    412          * @param {string|JQuery<HTMLElement>|HTMLElement} textarea - The HTML id, jQuery object, or DOM Element for the textarea that is used for the editor.
    413          * @param {CodeEditorSettings}    [settings] - Settings to override defaults.
     412         * @param {string|JQuery<HTMLElement>|HTMLElement} textarea   The HTML id, jQuery object, or DOM Element for the textarea that is used for the editor.
     413         * @param {CodeEditorSettings}                     [settings] Settings to override defaults.
    414414         *
    415415         * @return {CodeEditorInstance} Instance.

  • trunk/src/js/_enqueues/wp/custom-header.js

    r63556 r63600  
    2020         *
    2121         * @param {Element} target HTML element to dispatch the event on.
    22          * @param {string} name Event name.
     22         * @param {string}  name  Event name.
    2323         */
    2424        function trigger( target, name ) {

  • trunk/src/js/_enqueues/wp/customize/base.js

    r63525 r63600  
    569569                 *
    570570                 * For example:
    571                  *     when( id1, id2, id3, function( value1, value2, value3 ) {} );
     571                 * when( id1, id2, id3, function( value1, value2, value3 ) {} );
    572572                 *
    573573                 * @param {...(string|Function)} ids Zero or more IDs of items to wait for, optionally followed by

  • trunk/src/js/_enqueues/wp/customize/controls.js

    r63556 r63600  
    31023102
    31033103                /**
    3104                  *  Class wp.customize.ThemesPanel.
     3104                 * Class wp.customize.ThemesPanel.
    31053105                 *
    31063106                 * Custom section for themes that displays without the customize preview.

  • trunk/src/js/_enqueues/wp/customize/loader.js

    r63525 r63600  
    3434         * an iframe overlay with the URL specified.
    3535         *
    36          *     e.g. <a class="load-customize" href="<?php echo wp_customize_url(); ?>">Open Customizer</a>
     36         * e.g. <a class="load-customize" href="<?php echo wp_customize_url(); ?>">Open Customizer</a>
    3737         *
    3838         * @memberOf wp.customize

  • trunk/src/js/_enqueues/wp/dashboard.js

    r63598 r63600  
    6868         *
    6969         * @global
    70          */
     70         */
    7171        window.ajaxWidgets = ['dashboard_primary'];
    7272
    … …  
    8686                 * Fetch the latest representation of the widget via Ajax and show it.
    8787                 *
    88                  * @param {number} i Number of half-seconds to use as the timeout.
     88                 * @param {number} i  Number of half-seconds to use as the timeout.
    8989                 * @param {string} id ID of the element which is going to be checked for changes.
    9090                 *
    … …  
    164164                         *
    165165                         * @return {void}
    166                          */
     166                         */
    167167                        function highlightLatestPost () {
    168168                                var latestPost = $( '.drafts ul li' ) .first(),
    … …  
    836836 *
    837837 * @type {Object}
    838 */
     838 */
    839839window.communityEventsData.l10n = window.communityEventsData.l10n || {
    840840        enter_closest_city: '',

  • trunk/src/js/_enqueues/wp/editor/base.js

    r63556 r63600  
    7979                 * @memberof switchEditors
    8080                 *
    81                  * @param {string} id The id of the editor you want to change the editor mode for. Default: `content`.
     81                 * @param {string} id   The id of the editor you want to change the editor mode for. Default: `content`.
    8282                 * @param {string} mode The mode you want to switch to. Default: `toggle`.
    8383                 * @return {void}
    … …  
    202202                 * e.g. `[caption]<img.../>..`.
    203203                 *
    204                  * @param {string} content The test content where the cursor is.
     204                 * @param {string} content        The test content where the cursor is.
    205205                 * @param {number} cursorPosition The cursor position inside the content.
    206206                 *
    … …  
    247247                 * something, instead of just losing focus and going to the start of the content.
    248248                 *
    249                  * @param {string} content The text content to check against.
    250                  * @param {number} cursorPosition    The cursor position to check.
     249                 * @param {string} content        The text content to check against.
     250                 * @param {number} cursorPosition The cursor position to check.
    251251                 *
    252252                 * @return {void|Object} Undefined if the cursor is not wrapped in a shortcode tag.
    … …  
    373373                 * Using DomQuery syntax to create it, since it's used as both text and as a DOM element.
    374374                 *
    375                  * @param {Object} domLib DOM library instance.
     375                 * @param {Object} domLib  DOM library instance.
    376376                 * @param {string} content The content to insert into the cursor marker element.
    377377                 * @return {Object} The cursor marker element.
    … …  
    396396                 * @link getShortcodeWrapperInfo
    397397                 *
    398                  * @param {string} content Textarea content that the cursors are in
     398                 * @param {string}                                   content        Textarea content that the cursors are in
    399399                 * @param {{cursorStart: number, cursorEnd: number}} cursorPositions Cursor start and end positions
    400400                 *
    … …  
    586586                 * from the window height, to get the proper viewport window, that the user sees.
    587587                 *
    588                  * @param {Object} editor TinyMCE editor instance.
     588                 * @param {Object} editor  TinyMCE editor instance.
    589589                 * @param {Object} element HTMLElement that should be scrolled into view.
    590590                 */
    … …  
    826826                 * @link findBookmarkedPosition
    827827                 *
    828                  * @param {Object} editor TinyMCE's editor instance.
     828                 * @param {Object} editor    TinyMCE's editor instance.
    829829                 * @param {Object} selection Selection data.
    830830                 */
    … …  
    12251225         * @since 4.8.0
    12261226         *
    1227          * @param {string} id The HTML id of the textarea that is used for the editor.
    1228          *                    Has to be jQuery compliant. No brackets, special chars, etc.
    1229          * @param {Object} settings Example:
     1227         * @param {string} id       The HTML id of the textarea that is used for the editor.
     1228         *                          Has to be jQuery compliant. No brackets, special chars, etc.
     1229         * @param {Object} settings The settings for initializing the editor.
     1230         *
     1231         * @example
     1232         * ```javascript
    12301233         * settings = {
    12311234         *    // See https://www.tinymce.com/docs/configure/integration-and-setup/.
    … …  
    12421245         *    }
    12431246         * }
     1247         *
     1248         * settings = {
     1249         *    // See https://www.tinymce.com/docs/configure/integration-and-setup/.
     1250         *    // Alternatively set to `true` to use the defaults.
     1251         *    tinymce: {
     1252         *        setup: function( editor ) {
     1253         *            console.log( 'Editor initialized', editor );
     1254         *        }
     1255         *    }
     1256         *
     1257         *    // Alternatively set to `true` to use the defaults.
     1258         *        quicktags: {
     1259         *        buttons: 'strong,em,link'
     1260         *    }
     1261         * }
     1262         * ```
    12441263         */
    12451264        wp.editor.initialize = function( id, settings ) {

  • trunk/src/js/_enqueues/wp/editor/dfw.js

    r63556 r63600  
    174174                 * @since 4.0.0
    175175                 *
    176                  * @param {event} event The TinyMCE editor init event.
     176                 * @param {event}  event The TinyMCE editor init event.
    177177                 * @param {Object} editor The editor to bind the vents on.
    178178                 *
    … …  
    14741474                 * @since 4.1.0
    14751475                 *
    1476                  * @param {event} event The TinyMCE editor setup event.
     1476                 * @param {event}  event The TinyMCE editor setup event.
    14771477                 * @param {Object} editor The editor to add the button to.
    14781478                 *
    … …  
    15231523                 * @since 4.1.0
    15241524                 *
    1525                  * @param {event} event The TinyMCE editor init event.
     1525                 * @param {event}  event The TinyMCE editor init event.
    15261526                 * @param {Object} editor The editor to bind events on.
    15271527                 *
    … …  
    15821582
    15831583                /**
    1584                  *  Binds events on quicktags init.
    1585                  *
    1586                  * @since 4.1.0
    1587                  *
    1588                  * @param {event} event The quicktags init event.
     1584                 * Binds events on quicktags init.
     1585                 *
     1586                 * @since 4.1.0
     1587                 *
     1588                 * @param {event}  event The quicktags init event.
    15891589                 * @param {Object} editor The editor to bind events on.
    15901590                 *

  • trunk/src/js/_enqueues/wp/embed.js

    r63556 r63600  
    22 * WordPress inline HTML embed
    33 *
    4  * @param {Window} window The global window object.
     4 * @param {Window}   window  The global window object.
    55 * @param {Document} document The global document object.
    66 * @since 4.4.0

  • trunk/src/js/_enqueues/wp/emoji.js

    r63407 r63600  
    33 * doesn't support emoji natively.
    44 *
    5  * @param {Window} window The global window object.
     5 * @param {Window} window   The global window object.
    66 * @param {Object} settings The settings object.
    77 * @output wp-includes/js/wp-emoji.js
    … …  
    191191                 * - When passed an element the emoji characters are replaced inline.
    192192                 * - When passed a string the emoji characters are replaced and the result is
    193                  *   returned.
     193                 * returned.
    194194                 *
    195195                 * @since 4.2.0

  • trunk/src/js/_enqueues/wp/heartbeat.js

    r63598 r63600  
    791791                 * Enqueues data to send with the next XHR.
    792792                 *
    793                  * As the data is send asynchronously, this function doesn't return the XHR
     793                 * As the data is sent asynchronously, this function doesn't return the XHR
    794794                 * response. To see the response, use the custom jQuery event 'heartbeat-tick'
    795                  * on the document, example:
     795                 * on the document.
     796                 *
     797                 * @example
     798                 * ```javascript
    796799                 *              $(document).on( 'heartbeat-tick.myname', function( event, data, textStatus, jqXHR ) {
    797800                 *                      // code
    798801                 *              });
     802                 * ```
     803                 *
    799804                 * If the same 'handle' is used more than once, the data is not overwritten when
    800805                 * the third argument is 'true'. Use `wp.heartbeat.isQueued('handle')` to see if

  • trunk/src/js/_enqueues/wp/media/audiovideo.js

    r63407 r63600  
    198198 * Shortcode modeling for video.
    199199 *
    200  *  `edit()` prepares the shortcode for the media modal.
    201  *  `shortcode()` builds the new shortcode after update.
     200 * `edit()` prepares the shortcode for the media modal.
     201 * `shortcode()` builds the new shortcode after update.
    202202 *
    203203 * @since 4.2.0

  • trunk/src/js/_enqueues/wp/media/editor.js

    r63598 r63600  
    2121        /**
    2222         * A helper mixin function to avoid truthy and falsey values being
    23          *   passed as an input that expects booleans. If key is undefined in the map,
    24          *   but has a default value, set it.
     23         * passed as an input that expects booleans. If key is undefined in the map,
     24         * but has a default value, set it.
    2525         *
    2626         * @param {Object} attrs Map of props from a shortcode or settings.
    27          * @param {string} key The key within the passed map to check for a value.
     27         * @param {string} key   The key within the passed map to check for a value.
    2828         * @return {mixed|undefined} The original or coerced value of key within attrs.
    2929         */
    … …  
    112112                 * Create link markup that is suitable for passing to the editor
    113113                 *
    114                  * @param {Object} props Attachment details (align, link, size, etc).
     114                 * @param {Object} props      Attachment details (align, link, size, etc).
    115115                 * @param {Object} attachment The attachment object, media version of Post.
    116116                 * @return {string} The link markup
    … …  
    138138                 * Create an Audio shortcode string that is suitable for passing to the editor
    139139                 *
    140                  * @param {Object} props Attachment details (align, link, size, etc).
     140                 * @param {Object} props      Attachment details (align, link, size, etc).
    141141                 * @param {Object} attachment The attachment object, media version of Post.
    142142                 * @return {string} The audio shortcode
    … …  
    148148                 * Create a Video shortcode string that is suitable for passing to the editor
    149149                 *
    150                  * @param {Object} props Attachment details (align, link, size, etc).
     150                 * @param {Object} props      Attachment details (align, link, size, etc).
    151151                 * @param {Object} attachment The attachment object, media version of Post.
    152152                 * @return {string} The video shortcode
    … …  
    160160                 * @access private
    161161                 *
    162                  * @param {string} type The shortcode tag name: 'audio' or 'video'.
    163                  * @param {Object} props Attachment details (align, link, size, etc).
     162                 * @param {string} type       The shortcode tag name: 'audio' or 'video'.
     163                 * @param {Object} props      Attachment details (align, link, size, etc).
    164164                 * @param {Object} attachment The attachment object, media version of Post.
    165165                 * @return {string} The media shortcode
    … …  
    207207                /**
    208208                 * Create image markup, optionally with a link and/or wrapped in a caption shortcode,
    209                  *  that is suitable for passing to the editor
    210                  *
    211                  * @param {Object} props Attachment details (align, link, size, etc).
     209                 * that is suitable for passing to the editor
     210                 *
     211                 * @param {Object} props      Attachment details (align, link, size, etc).
    212212                 * @param {Object} attachment The attachment object, media version of Post.
    213213                 * @return {string} The image markup.
    … …  
    419419                         *
    420420                         * @param {wp.media.model.Attachments} attachments A Backbone.Collection containing
    421                          *      the media items belonging to a collection.
    422                          *      The query[ this.tag ] property is a Backbone.Model
    423                          *          containing the 'props' for the collection.
     421                         *                                                 the media items belonging to a collection.
     422                         *                                                 The query[ this.tag ] property is a Backbone.Model
     423                         *                                                 containing the 'props' for the collection.
    424424                         * @return {wp.shortcode} A wp.shortcode instance representing the collection.
    425425                         */
    … …  
    486486                        /**
    487487                         * Triggered when double-clicking a collection shortcode placeholder
    488                          *   in the editor
     488                         * in the editor
    489489                         *
    490490                         * @param {string} content Content that is searched for possible
    491                          *    shortcode markup matching the passed tag name,
     491                         *                         shortcode markup matching the passed tag name,
    492492                         *
    493493                         * @this wp.media.{prop}
    … …  
    690690                /**
    691691                 * 'select' callback for Featured Image workflow, triggered when
    692                  *  the 'Set Featured Image' button is clicked in the media modal.
     692                 * the 'Set Featured Image' button is clicked in the media modal.
    693693                 *
    694694                 * @this wp.media.controller.FeaturedImage
    … …  
    785785                /**
    786786                 * Setup 'workflow' and add to the 'workflows' cache. 'open' can
    787                  *  subsequently be called upon it.
     787                 * subsequently be called upon it.
    788788                 *
    789789                 * @param {string} id           A slug used to identify the workflow.
    … …  
    944944                        /**
    945945                         * Called when sending an attachment to the editor
    946                          *   from the medial modal.
     946                         * from the medial modal.
    947947                         *
    948                          * @param {Object} props Attachment details (align, link, size, etc).
     948                         * @param {Object} props      Attachment details (align, link, size, etc).
    949949                         * @param {Object} attachment The attachment object, media version of Post.
    950950                         * @return {Promise} A promise that resolves when the attachment has been sent to the editor.

  • trunk/src/js/_enqueues/wp/password-strength-meter.js

    r63359 r63600  
    2727                 * @since 3.7.0
    2828                 *
    29                  * @param {string} password1       The subject password.
     29                 * @param {string} password1      The subject password.
    3030                 * @param {Array}  disallowedList An array of words that will lower the entropy of
    31                  *                                 the password.
    32                  * @param {string} password2       The password confirmation.
     31                 *                                the password.
     32                 * @param {string} password2      The password confirmation.
    3333                 *
    3434                 * @return {number} The password strength score.

  • trunk/src/js/_enqueues/wp/sanitize.js

    r63514 r63600  
    2020                 * Strip HTML tags.
    2121                 *
    22                  * @param {string} text - Text to strip the HTML tags from.
     22                 * @param {string} text Text to strip the HTML tags from.
    2323                 *
    2424                 * @return {string} Stripped text.
    … …  
    5353                 * Strip HTML tags and convert HTML entities.
    5454                 *
    55                  * @param {string} text - Text to strip tags and convert HTML entities.
     55                 * @param {string} text Text to strip tags and convert HTML entities.
    5656                 *
    5757                 * @return {string} Sanitized text.

  • trunk/src/js/_enqueues/wp/theme-plugin-editor.js

    r63556 r63600  
    3030         * @since 4.9.0
    3131         *
    32          * @param {jQuery}         form - Form element.
    33          * @param {Object}         settings - Settings.
    34          * @param {Object|boolean} settings.codeEditor - Code editor settings (or `false` if syntax highlighting is disabled).
     32         * @param {jQuery}         form               Form element.
     33         * @param {Object}         settings           Settings.
     34         * @param {Object|boolean} settings.codeEditor Code editor settings (or `false` if syntax highlighting is disabled).
    3535         * @return {void}
    3636         */
    … …  
    188188         *
    189189         * @since 4.9.0
    190          * @param {jQuery.Event} event - Event.
     190         * @param {jQuery.Event} event Event.
    191191         * @return {void}
    192192         */
    … …  
    274274         * @since 4.9.0
    275275         *
    276          * @param {Object}   notice - Notice.
    277          * @param {string}   notice.code - Code.
    278          * @param {string}   notice.type - Type.
    279          * @param {string}   notice.message - Message.
    280          * @param {boolean}  [notice.dismissible=false] - Dismissible.
    281          * @param {Function} [notice.onDismiss] - Callback for when a user dismisses the notice.
     276         * @param {Object}   notice                     Notice.
     277         * @param {string}   notice.code               Code.
     278         * @param {string}   notice.type               Type.
     279         * @param {string}   notice.message             Message.
     280         * @param {boolean}  [notice.dismissible=false] Dismissible.
     281         * @param {Function} [notice.onDismiss]         Callback for when a user dismisses the notice.
    282282         * @return {jQuery} Notice element.
    283283         */
    … …  
    315315         * @since 4.9.0
    316316         *
    317          * @param {string} code - Notice code.
     317         * @param {string} code Notice code.
    318318         * @return {boolean} Whether a notice was removed.
    319319         */
    … …  
    367367                 * @since 4.9.0
    368368                 *
    369                  * @param {Array} errors - List of linting errors.
     369                 * @param {Array} errors List of linting errors.
    370370                 * @return {void}
    371371                 */
    … …  
    384384                 * @since 4.9.0
    385385                 *
    386                  * @param {Array} errorAnnotations - Error annotations.
     386                 * @param {Array} errorAnnotations Error annotations.
    387387                 * @return {void}
    388388                 */
    … …  
    492492        var TreeitemLink = (function () {
    493493                /**
    494                  *   This content is licensed according to the W3C Software License at
    495                  *   https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
    496                  *
    497                  *   File:   TreeitemLink.js
    498                  *
    499                  *   Desc:   Treeitem widget that implements ARIA Authoring Practices
    500                  *           for a tree being used as a file viewer
    501                  *
    502                  *   Author: Jon Gunderson, Ku Ja Eun and Nicholas Hoyt
     494                 * This content is licensed according to the W3C Software License at
     495                 * https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document
     496                 *
     497                 * File:   TreeitemLink.js
     498                 *
     499                 * Desc:   Treeitem widget that implements ARIA Authoring Practices
     500                 * for a tree being used as a file viewer
     501                 *
     502                 * Author: Jon Gunderson, Ku Ja Eun and Nicholas Hoyt
    503503                 */
    504504
    505505                /**
    506                  *   @class
    507                  *
    508                  *   @description
    509                  *       Treeitem object for representing the state and user interactions for a
    510                  *       treeItem widget
    511                  *
    512                  *   @param node
    513                  *       An element with the role=tree attribute
     506                 * @class
     507                 *
     508                 * Treeitem object for representing the state and user interactions for a
     509                 * treeItem widget
     510                 *
     511                 * @param node An element with the role=tree attribute
    514512                 */
    515513

  • trunk/src/js/_enqueues/wp/theme.js

    r63407 r63600  
    14861486 * @since 4.9.0
    14871487 *
    1488  * @param {string} url - URL to navigate to.
    1489  * @param {Object} state - State.
     1488 * @param {string} url   URL to navigate to.
     1489 * @param {Object} state State.
    14901490 * @return {void}
    14911491 */

  • trunk/src/js/_enqueues/wp/updates.js

    r63598 r63600  
    11161116         * @since 6.5.0
    11171117         *
    1118          * @param {Object} response             Response from the server.
    1119          * @param {string} response.slug        Slug of the activated plugin.
    1120          * @param {string} response.pluginName  Name of the activated plugin.
    1121          * @param {string} response.plugin      The plugin file, relative to the plugins directory.
     1118         * @param {Object} response            Response from the server.
     1119         * @param {string} response.slug       Slug of the activated plugin.
     1120         * @param {string} response.pluginName Name of the activated plugin.
     1121         * @param {string} response.plugin     The plugin file, relative to the plugins directory.
    11221122         */
    11231123        wp.updates.activatePluginSuccess = function( response ) {

  • trunk/src/js/_enqueues/wp/utils/word-count.js

    r48650 r63600  
    149149         * @memberof wp.utils.wordcounter
    150150         *
    151          * @param {string}  text Text to count elements in.
    152          * @param {string}  type Optional. Specify type to use.
     151         * @param {string} text Text to count elements in.
     152         * @param {string} type Optional. Specify type to use.
    153153         *
    154154         * @return {number} The number of items counted.

  • trunk/src/js/_enqueues/wp/widgets/custom-html.js

    r63408 r63600  
    4343                 * @abstract
    4444                 *
    45                  * @param {Object} options - Options.
    46                  * @param {jQuery} options.el - Control field container element.
    47                  * @param {jQuery} options.syncContainer - Container element where fields are synced for the server.
     45                 * @param {Object} options               Options.
     46                 * @param {jQuery} options.el           Control field container element.
     47                 * @param {jQuery} options.syncContainer Container element where fields are synced for the server.
    4848                 *
    4949                 * @return {void}
    … …  
    125125                 * Show linting error notice.
    126126                 *
    127                  * @param {Array} errorAnnotations - Error annotations.
     127                 * @param {Array} errorAnnotations Error annotations.
    128128                 * @return {void}
    129129                 */
    … …  
    206206                                 * @ignore
    207207                                 *
    208                                  * @param {Array} errorAnnotations - Error notifications.
     208                                 * @param {Array} errorAnnotations Error notifications.
    209209                                 * @return {void}
    210210                                 */
    … …  
    218218                                 * @ignore
    219219                                 *
    220                                  * @param {Array} errorAnnotations - Error annotations.
     220                                 * @param {Array} errorAnnotations Error annotations.
    221221                                 * @return {void}
    222222                                 */
    … …  
    288288         * @alias wp.customHtmlWidgets.handleWidgetAdded
    289289         *
    290          * @param {jQuery.Event} event - Event.
    291          * @param {jQuery}       widgetContainer - Widget container element.
     290         * @param {jQuery.Event} event           Event.
     291         * @param {jQuery}       widgetContainer Widget container element.
    292292         *
    293293         * @return {void}
    … …  
    385385         * @alias wp.customHtmlWidgets.handleWidgetUpdated
    386386         *
    387          * @param {jQuery.Event} event - Event.
    388          * @param {jQuery}       widgetContainer - Widget container element.
     387         * @param {jQuery.Event} event           Event.
     388         * @param {jQuery}       widgetContainer Widget container element.
    389389         * @return {void}
    390390         */
    … …  
    416416         * @alias wp.customHtmlWidgets.init
    417417         *
    418          * @param {Object} settings - Options for code editor, exported from PHP.
     418         * @param {Object} settings Options for code editor, exported from PHP.
    419419         *
    420420         * @return {void}

  • trunk/src/js/_enqueues/wp/widgets/media-audio.js

    r46800 r63600  
    7070                 * Map model props to media frame props.
    7171                 *
    72                  * @param {Object} modelProps - Model props.
     72                 * @param {Object} modelProps Model props.
    7373                 * @return {Object} Media frame props.
    7474                 */

  • trunk/src/js/_enqueues/wp/widgets/media-gallery.js

    r63408 r63600  
    8585                 *
    8686                 * @since 4.9.0
    87                  * @param {Object}         options - Options.
    88                  * @param {Backbone.Model} options.model - Model.
    89                  * @param {jQuery}         options.el - Control field container element.
    90                  * @param {jQuery}         options.syncContainer - Container element where fields are synced for the server.
     87                 * @param {Object}         options               Options.
     88                 * @param {Backbone.Model} options.model         Model.
     89                 * @param {jQuery}         options.el           Control field container element.
     90                 * @param {jQuery}         options.syncContainer Container element where fields are synced for the server.
    9191                 * @return {void}
    9292                 */
    … …  
    321321                 *
    322322                 * @since 4.9.0
    323                  * @param {wp.media.models.Attachment} attachment - Attachment.
     323                 * @param {wp.media.models.Attachment} attachment Attachment.
    324324                 * @return {void}
    325325                 */

  • trunk/src/js/_enqueues/wp/widgets/media-image.js

    r63408 r63600  
    138138                 * Prevent the image_title attribute from being initially set when adding an image from the media library.
    139139                 *
    140                  * @param {wp.media.view.MediaFrame.Select} mediaFrame - Select frame.
     140                 * @param {wp.media.view.MediaFrame.Select} mediaFrame Select frame.
    141141                 * @return {Object} Props.
    142142                 */

  • trunk/src/js/_enqueues/wp/widgets/media-video.js

    r46800 r63600  
    8888                 * Map model props to media frame props.
    8989                 *
    90                  * @param {Object} modelProps - Model props.
     90                 * @param {Object} modelProps Model props.
    9191                 * @return {Object} Media frame props.
    9292                 */

  • trunk/src/js/_enqueues/wp/widgets/media.js

    r63408 r63600  
    4646                 * @augments   wp.media.controller.Library
    4747                 *
    48                  * @param {Object} options - Options.
     48                 * @param {Object} options Options.
    4949                 *
    5050                 * @return {void}
    … …  
    5858                 * Sync changes to the current display settings back into the current customized.
    5959                 *
    60                  * @param {Backbone.Model} displaySettings - Modified display settings.
     60                 * @param {Backbone.Model} displaySettings Modified display settings.
    6161                 * @return {void}
    6262                 */
    … …  
    7373                 * settings.
    7474                 *
    75                  * @param {Backbone.Model} model - Display settings model.
     75                 * @param {Backbone.Model} model Display settings model.
    7676                 * @return {Backbone.Model} Display settings model.
    7777                 */
    … …  
    103103                 * @since 4.9.0
    104104                 *
    105                  * @param {Object} options - Options.
     105                 * @param {Object} options Options.
    106106                 * @return {void}
    107107                 */
    … …  
    138138                                         * Set the disabled state on the Add to Widget button.
    139139                                         *
    140                                          * @param {boolean} disabled - Disabled.
     140                                         * @param {boolean} disabled Disabled.
    141141                                         * @return {void}
    142142                                         */
    … …  
    148148                                         * Set or clear an error notice.
    149149                                         *
    150                                          * @param {string} notice - Notice.
     150                                         * @param {string} notice Notice.
    151151                                         * @return {void}
    152152                                         */
    … …  
    359359                 * Forked override of {wp.media.view.MediaFrame.Post#mainInsertToolbar()} to override text.
    360360                 *
    361                  * @param {wp.Backbone.View} view - Toolbar view.
     361                 * @param {wp.Backbone.View} view Toolbar view.
    362362                 * @this {wp.media.controller.Library}
    363363                 * @return {void}
    … …  
    394394                 * Forked override of {wp.media.view.MediaFrame.Post#mainEmbedToolbar()} to override text.
    395395                 *
    396                  * @param {wp.Backbone.View} toolbar - Toolbar view.
     396                 * @param {wp.Backbone.View} toolbar Toolbar view.
    397397                 * @this {wp.media.controller.Library}
    398398                 * @return {void}
    … …  
    487487                 * @abstract
    488488                 *
    489                  * @param {Object}         options - Options.
    490                  * @param {Backbone.Model} options.model - Model.
    491                  * @param {jQuery}         options.el - Control field container element.
    492                  * @param {jQuery}         options.syncContainer - Container element where fields are synced for the server.
     489                 * @param {Object}         options               Options.
     490                 * @param {Backbone.Model} options.model         Model.
     491                 * @param {jQuery}         options.el           Control field container element.
     492                 * @param {jQuery}         options.syncContainer Container element where fields are synced for the server.
    493493                 *
    494494                 * @return {void}
    … …  
    722722                 * Handle click on link to Media Library to open modal, such as the link that appears when in the missing attachment error notice.
    723723                 *
    724                  * @param {jQuery.Event} event - Event.
     724                 * @param {jQuery.Event} event Event.
    725725                 * @return {void}
    726726                 */
    … …  
    820820                 * Get the instance props from the media selection frame.
    821821                 *
    822                  * @param {wp.media.view.MediaFrame.Select} mediaFrame - Select frame.
     822                 * @param {wp.media.view.MediaFrame.Select} mediaFrame Select frame.
    823823                 * @return {Object} Props.
    824824                 */
    … …  
    869869                 * Map media frame props to model props.
    870870                 *
    871                  * @param {Object} mediaFrameProps - Media frame props.
     871                 * @param {Object} mediaFrameProps Media frame props.
    872872                 * @return {Object} Model props.
    873873                 */
    … …  
    920920                 * Map model props to media frame props.
    921921                 *
    922                  * @param {Object} modelProps - Model props.
     922                 * @param {Object} modelProps Model props.
    923923                 * @return {Object} Media frame props.
    924924                 */
    … …  
    10291029                 * the appropriate data types (integers or booleans).
    10301030                 *
    1031                  * @param {string|Object} key - Attribute name or attribute pairs.
    1032                  * @param {mixed|Object}  [val] - Attribute value or options object.
    1033                  * @param {Object}        [options] - Options when attribute name and value are passed separately.
     1031                 * @param {string|Object} key       Attribute name or attribute pairs.
     1032                 * @param {mixed|Object}  [val]     Attribute value or options object.
     1033                 * @param {Object}        [options] Options when attribute name and value are passed separately.
    10341034                 * @return {wp.mediaWidgets.MediaWidgetModel} This model.
    10351035                 */
    … …  
    11201120         * @memberOf wp.mediaWidgets
    11211121         *
    1122          * @param {jQuery.Event} event - Event.
    1123          * @param {jQuery}       widgetContainer - Widget container element.
     1122         * @param {jQuery.Event} event           Event.
     1123         * @param {jQuery}       widgetContainer Widget container element.
    11241124         *
    11251125         * @return {void}
    … …  
    12571257         * @memberOf wp.mediaWidgets
    12581258         *
    1259          * @param {jQuery.Event} event - Event.
    1260          * @param {jQuery}       widgetContainer - Widget container element.
     1259         * @param {jQuery.Event} event           Event.
     1260         * @param {jQuery}       widgetContainer Widget container element.
    12611261         *
    12621262         * @return {void}

  • trunk/src/js/_enqueues/wp/widgets/text.js

    r63408 r63600  
    3535                 * @abstract
    3636                 *
    37                  * @param {Object} options - Options.
    38                  * @param {jQuery} options.el - Control field container element.
    39                  * @param {jQuery} options.syncContainer - Container element where fields are synced for the server.
     37                 * @param {Object} options               Options.
     38                 * @param {jQuery} options.el           Control field container element.
     39                 * @param {jQuery} options.syncContainer Container element where fields are synced for the server.
    4040                 *
    4141                 * @return {void}
    … …  
    377377         * @memberOf wp.textWidgets
    378378         *
    379          * @param {jQuery.Event} event - Event.
    380          * @param {jQuery}       widgetContainer - Widget container element.
     379         * @param {jQuery.Event} event           Event.
     380         * @param {jQuery}       widgetContainer Widget container element.
    381381         *
    382382         * @return {void}
    … …  
    485485         * @memberOf wp.textWidgets
    486486         *
    487          * @param {jQuery.Event} event - Event.
    488          * @param {jQuery}       widgetContainer - Widget container element.
     487         * @param {jQuery.Event} event           Event.
     488         * @param {jQuery}       widgetContainer Widget container element.
    489489         * @return {void}
    490490         */

  • trunk/src/js/media/controllers/state.js

    r63516 r63600  
    77 * A state has an event-driven lifecycle:
    88 *
    9  *     'ready'      triggers when a state is added to a state machine's collection.
    10  *     'activate'   triggers when a state is activated by a state machine.
    11  *     'deactivate' triggers when a state is deactivated by a state machine.
    12  *     'reset'      is not triggered automatically. It should be invoked by the
    13  *                  proper controller to reset the state to its default.
     9 * 'ready'      triggers when a state is added to a state machine's collection.
     10 * 'activate'   triggers when a state is activated by a state machine.
     11 * 'deactivate' triggers when a state is deactivated by a state machine.
     12 * 'reset'      is not triggered automatically. It should be invoked by the
     13 * proper controller to reset the state to its default.
    1414 *
    1515 * @memberOf wp.media.controller
    … …  
    8686         * @since 3.5.0
    8787         * @access private
    88         */
     88         */
    8989        _preActivate: function() {
    9090                this.active = true;

  • trunk/src/js/media/models/attachment.js

    r63598 r63600  
    116116         * Saves attachment details using the `save-attachment-compat` action.
    117117         *
    118          * @param {Object} data The properties to be saved.
     118         * @param {Object} data    The properties to be saved.
    119119         * @param {Object} options Sync options. e.g. patch, wait, success, error.
    120120         *

  • trunk/src/js/media/models/attachments.js

    r63598 r63600  
    1919 * @param {string}                      [options.props.orderby] Initial attribute key to order the collection by.
    2020 * @param {string}                      [options.props.query]   Whether the collection is linked to an attachments query.
    21  * @param {string}                      [options.observe]           An attachments collection to observe and mirror.
    22  * @param {string}                      [options.filters]           Filters to apply to the collection.
     21 * @param {string}                      [options.observe]       An attachments collection to observe and mirror.
     22 * @param {string}                      [options.filters]       Filters to apply to the collection.
    2323 *
    2424 */

  • trunk/src/js/media/models/post-media.js

    r43309 r63600  
    33 *
    44 * Shared model class for audio and video. Updates the model after
    5  *   "Add Audio|Video Source" and "Replace Audio|Video" states return
     5 * "Add Audio|Video Source" and "Replace Audio|Video" states return
    66 *
    77 * @memberOf wp.media.model

  • trunk/src/js/media/models/query.js

    r63598 r63600  
    88 *
    99 * Note: Do NOT change this.args after the query has been initialized.
    10  *       Things will break.
     10 * Things will break.
    1111 *
    1212 * @memberOf wp.media.model

  • trunk/src/js/media/views/attachments/browser.js

    r63516 r63600  
    188188
    189189                /**
    190                 * @member {wp.media.view.Toolbar}
    191                 */
     190                 * @member {wp.media.view.Toolbar}
     191                 */
    192192                this.toolbar = new wp.media.view.Toolbar( toolbarOptions );
    193193

  • trunk/src/js/media/views/focus-manager.js

    r63409 r63600  
    3232
    3333        /**
    34         * Determines which focus management mode to use.
    35         *
    36         * @since 5.3.0
    37         *
    38         * @param {Object} event jQuery event object.
    39         *
    40         * @return {void}
    41         */
     34  * Determines which focus management mode to use.
     35  *
     36  * @since 5.3.0
     37  *
     38  * @param {Object} event jQuery event object.
     39  *
     40  * @return {void}
     41  */
    4242        focusManagementMode: function( event ) {
    4343                if ( this.mode === 'constrainTabbing' ) {

  • trunk/tools/gutenberg/copy.js

    r62645 r63600  
    3535 * @typedef ScriptsConfig
    3636 * @type {object}
    37  * @property {string}                 source           - Gutenberg-relative source directory (e.g. `'scripts'`).
    38  * @property {string}                 destination      - Subpath under `wp-includes/` where packages land (e.g. `'js/dist'`).
    39  * @property {boolean}                copyDirectories  - Whether to copy whole directories (with optional renames) as-is.
    40  * @property {Record<string, string>} directoryRenames - Map of source directory name → destination directory name.
     37 * @property {string}                 source           Gutenberg-relative source directory (e.g. `'scripts'`).
     38 * @property {string}                 destination      Subpath under `wp-includes/` where packages land (e.g. `'js/dist'`).
     39 * @property {boolean}                copyDirectories  Whether to copy whole directories (with optional renames) as-is.
     40 * @property {Record<string, string>} directoryRenames Map of source directory name → destination directory name.
    4141 */
    4242
    … …  
    4646 * @typedef BlockConfigSource
    4747 * @type {object}
    48  * @property {string} name    - Human-readable label (e.g. `'block-library'`, `'widgets'`).
    49  * @property {string} scripts - Gutenberg-relative path to the block scripts directory.
    50  * @property {string} styles  - Gutenberg-relative path to the block styles directory.
    51  * @property {string} php     - Gutenberg-relative path to the block PHP directory.
     48 * @property {string} name    Human-readable label (e.g. `'block-library'`, `'widgets'`).
     49 * @property {string} scripts Gutenberg-relative path to the block scripts directory.
     50 * @property {string} styles  Gutenberg-relative path to the block styles directory.
     51 * @property {string} php     Gutenberg-relative path to the block PHP directory.
    5252 */
    5353
    … …  
    5757 * @typedef BlockConfig
    5858 * @type {object}
    59  * @property {string}              destination - Subpath under `wp-includes/` where blocks land (e.g. `'blocks'`).
    60  * @property {BlockConfigSource[]} sources     - One entry per block family.
     59 * @property {string}              destination Subpath under `wp-includes/` where blocks land (e.g. `'blocks'`).
     60 * @property {BlockConfigSource[]} sources     One entry per block family.
    6161 */
    6262
    … …  
    119119 * Check if a block is experimental by reading its block.json.
    120120 *
    121  * @param {string} blockJsonPath - Path to block.json file.
     121 * @param {string} blockJsonPath Path to block.json file.
    122122 * @return {boolean} True if block is experimental.
    123123 */
    … …  
    141141 * Blocks marked as `"__experimental": true` in a `block.json` file are excluded.
    142142 *
    143  * @param {string} scriptsSrc - Path to the Gutenberg scripts source (e.g. `scripts/block-library`).
     143 * @param {string} scriptsSrc Path to the Gutenberg scripts source (e.g. `scripts/block-library`).
    144144 * @return {string[]} Stable block directory names.
    145145 */
    … …  
    160160 * Copy JavaScript files.
    161161 *
    162  * @param {ScriptsConfig} config - Scripts configuration from `COPY_CONFIG.scripts`.
     162 * @param {ScriptsConfig} config Scripts configuration from `COPY_CONFIG.scripts`.
    163163 */
    164164function copyScripts( config ) {
    … …  
    249249 * Copy `block.json` files for every stable block.
    250250 *
    251  * @param {BlockConfig} config - Block configuration from `COPY_CONFIG.blocks`.
     251 * @param {BlockConfig} config Block configuration from `COPY_CONFIG.blocks`.
    252252 */
    253253function copyBlockJson( config ) {
    … …  
    284284 * `*.php` helpers under `<block>/` (e.g. `navigation-link/shared/render-submenu-icon.php`).
    285285 *
    286  * @param {BlockConfig} config - Block configuration from `COPY_CONFIG.blocks`.
     286 * @param {BlockConfig} config Block configuration from `COPY_CONFIG.blocks`.
    287287 */
    288288function copyBlockPhp( config ) {
    … …  
    339339 * Copy per-block CSS files for every stable block.
    340340 *
    341  * @param {BlockConfig} config - Block configuration from `COPY_CONFIG.blocks`.
     341 * @param {BlockConfig} config Block configuration from `COPY_CONFIG.blocks`.
    342342 */
    343343function copyBlockStyles( config ) {
    … …  
    392392         * Recursively process directory to find .asset.php files.
    393393         *
    394          * @param {string} dir - Directory to process.
    395          * @param {string} baseDir - Base directory for relative paths.
     394         * @param {string} dir Directory to process.
     395         * @param {string} baseDir Base directory for relative paths.
    396396         */
    397397        function processDirectory( dir, baseDir ) {
Note: See TracChangeset for help on using the changeset viewer.