WordPress.org

Make WordPress Core

Ticket #43828: 43828.5.diff

File 43828.5.diff, 205.6 KB (added by whyisjake, 13 months ago)
  • package.json

     
    155155                "test": "grunt test",
    156156                "watch": "grunt watch",
    157157                "grunt": "grunt",
     158                "lint:jsdoc": "wp-scripts lint-js",
     159                "lint:jsdoc:fix": "wp-scripts lint-js --fix",
    158160                "env:start": "node ./tools/local-env/scripts/start.js",
    159161                "env:stop": "node ./tools/local-env/scripts/docker.js down",
    160162                "env:restart": "npm run env:stop && npm run env:start",
  • src/js/_enqueues/admin/common.js

     
    137137         *
    138138         * @since 3.1.0
    139139         *
    140          * @param {int} diff The modifier for the column span.
     140         * @param {number} diff The modifier for the column span.
    141141         */
    142142        colSpanChange : function(diff) {
    143143                var $t = $('table').find('.colspanchange'), n;
     
    384384 * If the structure is already used in the custom permalink structure,
    385385 * it will be disabled.
    386386 *
    387  * @param {object} button Button jQuery object.
     387 * @param {Object} button Button jQuery object.
    388388 */
    389389function changeStructureTagButtonState( button ) {
    390390        if ( -1 !== $permalinkStructure.val().indexOf( button.text().trim() ) ) {
  • src/js/_enqueues/admin/edit-comments.js

     
    159159         *
    160160         * @since 5.2.0
    161161         *
    162          * @param {object} response Ajax response from the server that includes a
     162         * @param {Object} response Ajax response from the server that includes a
    163163         *                          translated "comments in moderation" message.
    164164         *
    165165         * @return {void}
  • src/js/_enqueues/admin/inline-edit-post.js

     
    389389         *
    390390         * @since 2.7.0
    391391         *
    392          * @param {int} id The ID for the post that has been changed.
     392         * @param {number} id The ID for the post that has been changed.
    393393         * @return {boolean} False, so the form does not submit when pressing
    394394         *                   Enter on a focused field.
    395395         */
  • src/js/_enqueues/admin/post.js

     
    3434                 *
    3535                 * @memberof commentsBox
    3636                 *
    37                  * @param {int} total Total number of comments for this post.
    38                  * @param {int} num   Optional. Number of comments to fetch, defaults to 20.
     37                 * @param {number} total Total number of comments for this post.
     38                 * @param {number} num   Optional. Number of comments to fetch, defaults to 20.
    3939                 * @return {boolean} Always returns false.
    4040                 */
    4141                get : function(total, num) {
     
    9494                 *
    9595                 * @memberof commentsBox
    9696                 *
    97                  * @param {int} total Total number of comments to load.
     97                 * @param {number} total Total number of comments to load.
    9898                 */
    9999                load: function(total){
    100100                        this.st = jQuery('#the-comment-list tr.comment:visible').length;
     
    116116        /**
    117117         * Set the Image ID of the Featured Image
    118118         *
    119          * @param {int} id The post_id of the image to use as Featured Image.
     119         * @param {number} id The post_id of the image to use as Featured Image.
    120120         *
    121121         * @global
    122122         */
  • src/js/_enqueues/admin/postbox.js

     
    154154                 * @since 5.5.0
    155155                 *
    156156                 * @param {string} position The "previous" or "next" sortables area.
    157                  * @param {object} button   The jQuery object representing the button that was clicked.
    158                  * @param {object} postbox  The jQuery object representing the postbox to be moved.
     157                 * @param {Object} button   The jQuery object representing the button that was clicked.
     158                 * @param {Object} postbox  The jQuery object representing the postbox to be moved.
    159159                 *
    160160                 * @return {void}
    161161                 */
  • src/js/_enqueues/admin/tags-suggest.js

     
    3030         *
    3131         * @since 4.7.0
    3232         *
    33          * @param {object} options Options that are passed to UI Autocomplete. Can be used to override the default settings.
    34          * @return {object} jQuery instance.
     33         * @param {Object} options Options that are passed to UI Autocomplete. Can be used to override the default settings.
     34         * @return {Object} jQuery instance.
    3535         */
    3636        $.fn.wpTagsSuggest = function( options ) {
    3737                var cache;
  • src/js/_enqueues/admin/widgets.js

     
    234234                         *
    235235                         * @ignore
    236236                         *
    237                          * @param {object} event jQuery event object.
     237                         * @param {Object} event jQuery event object.
    238238                         */
    239239                        over: function( event ) {
    240240                                var $wrap = $( event.target ).parent();
     
    259259                         *
    260260                         * @ignore
    261261                         *
    262                          * @param {object} event jQuery event object.
     262                         * @param {Object} event jQuery event object.
    263263                         */
    264264                        out: function( event ) {
    265265                                if ( wpWidgets.hoveredSidebar ) {
     
    729729         *
    730730         * Used when a Widget gets dragged in/out of the Sidebar and never dropped.
    731731         *
    732          * @param {object} event jQuery event object.
     732         * @param {Object} event jQuery event object.
    733733         */
    734734        closeSidebar: function( event ) {
    735735                this.hoveredSidebar
  • src/js/_enqueues/lib/admin-bar.js

     
    294294         * @since 5.3.1
    295295         *
    296296         * @param {HTMLElement} element The HTML element.
    297          * @param {String}      className The class name.
    298          * @return {bool} Whether the element has the className.
     297         * @param {string}      className The class name.
     298         * @return {boolean} Whether the element has the className.
    299299         */
    300300        function hasClass( element, className ) {
    301301                var classNames;
     
    320320         * @since 5.3.1
    321321         *
    322322         * @param {HTMLElement} element The HTML element.
    323          * @param {String}      className The class name.
     323         * @param {string}      className The class name.
    324324         */
    325325        function addClass( element, className ) {
    326326                if ( ! element ) {
     
    344344         * @since 5.3.1
    345345         *
    346346         * @param {HTMLElement} element The HTML element.
    347          * @param {String}      className The class name.
     347         * @param {string}      className The class name.
    348348         */
    349349        function removeClass( element, className ) {
    350350                var testName,
  • src/js/_enqueues/lib/comment-reply.js

     
    265265         * @since 5.1.0
    266266         *
    267267         * @param {HTMLElement} Element DOM element with the attribute.
    268          * @param {String}      Attribute the attribute to get.
     268         * @param {string}      Attribute the attribute to get.
    269269         *
    270          * @return {String}
     270         * @return {string}
    271271         */
    272272        function getDataAttribute( element, attribute ) {
    273273                if ( supportsDataset ) {
     
    298298         *
    299299         * @memberOf addComment
    300300         *
    301          * @param {String} addBelowId HTML ID of element the form follows.
    302          * @param {String} commentId  Database ID of comment being replied to.
    303          * @param {String} respondId  HTML ID of 'respond' element.
    304          * @param {String} postId     Database ID of the post.
    305          * @param {String} replyTo    Form heading content.
     301         * @param {string} addBelowId HTML ID of element the form follows.
     302         * @param {string} commentId  Database ID of comment being replied to.
     303         * @param {string} respondId  HTML ID of 'respond' element.
     304         * @param {string} postId     Database ID of the post.
     305         * @param {string} replyTo    Form heading content.
    306306         */
    307307        function moveForm( addBelowId, commentId, respondId, postId, replyTo ) {
    308308                // Get elements based on their IDs.
  • src/js/_enqueues/lib/image-edit.js

     
    7373         * @memberof imageEdit
    7474         *
    7575         * @param {jQuery}         el The element that should be modified.
    76          * @param {bool|number}    s  The state for the element. If set to true
     76         * @param {boolean|number}    s  The state for the element. If set to true
    7777         *                            the element is disabled,
    7878         *                            otherwise the element is enabled.
    7979         *                            The function is sometimes called with a 0 or 1
     
    577577         *
    578578         * @param {number} postid   The post ID for the image.
    579579         * @param {string} nonce    The nonce to verify the request.
    580          * @param {object} view     The image editor view to be used for the editing.
     580         * @param {Object} view     The image editor view to be used for the editing.
    581581         *
    582582         * @return {void|promise} Either returns void if the button was already activated
    583583         *                        or returns an instance of the image editor, wrapped in a promise.
     
    774774                         *
    775775                         * @ignore
    776776                         *
    777                          * @param {object} img jQuery object representing the image.
    778                          * @param {object} c   The selection.
     777                         * @param {Object} img jQuery object representing the image.
     778                         * @param {Object} c   The selection.
    779779                         *
    780                          * @return {object}
     780                         * @return {Object}
    781781                         */
    782782                        onSelectEnd: function(img, c) {
    783783                                imageEdit.setCropSelection(postid, c);
     
    788788                         *
    789789                         * @ignore
    790790                         *
    791                          * @param {object} img jQuery object representing the image.
    792                          * @param {object} c   The selection.
     791                         * @param {Object} img jQuery object representing the image.
     792                         * @param {Object} c   The selection.
    793793                         *
    794794                         * @return {void}
    795795                         */
     
    809809         * @memberof imageEdit
    810810         *
    811811         * @param {number} postid The post ID.
    812          * @param {object} c      The selection.
     812         * @param {Object} c      The selection.
    813813         *
    814814         * @return {boolean}
    815815         */
     
    841841         * @memberof imageEdit
    842842         *
    843843         * @param {number}  postid The post ID.
    844          * @param {bool}    warn   Warning message.
     844         * @param {boolean}    warn   Warning message.
    845845         *
    846          * @return {void|bool} Returns false if there is a warning.
     846         * @return {void|boolean} Returns false if there is a warning.
    847847         */
    848848        close : function(postid, warn) {
    849849                warn = warn || false;
     
    908908         *
    909909         * @memberof imageEdit
    910910         *
    911          * @param {object} op     The original position.
     911         * @param {Object} op     The original position.
    912912         * @param {number} postid The post ID.
    913913         * @param {string} nonce  The nonce.
    914914         *
     
    945945         * @param {string} angle  The angle the image is rotated with.
    946946         * @param {number} postid The post ID.
    947947         * @param {string} nonce  The nonce.
    948          * @param {object} t      The target element.
     948         * @param {Object} t      The target element.
    949949         *
    950950         * @return {boolean}
    951951         */
     
    967967         * @param {number} axis   The axle the image is flipped on.
    968968         * @param {number} postid The post ID.
    969969         * @param {string} nonce  The nonce.
    970          * @param {object} t      The target element.
     970         * @param {Object} t      The target element.
    971971         *
    972972         * @return {boolean}
    973973         */
     
    988988         *
    989989         * @param {number} postid The post ID.
    990990         * @param {string} nonce  The nonce.
    991          * @param {object} t      The target object.
     991         * @param {Object} t      The target object.
    992992         *
    993993         * @return {void|boolean} Returns false if the crop button is disabled.
    994994         */
  • src/js/_enqueues/lib/lists.js

     
    202202         * 6. 0 if none can be found.
    203203         *
    204204         * @param {jQuery} element  Element that triggered the request.
    205          * @param {object} settings Settings for the Ajax request.
     205         * @param {Object} settings Settings for the Ajax request.
    206206         * @return {string|number} Nonce
    207207         */
    208208        nonce: function( element, settings ) {
     
    258258         * Calls a confirm callback to verify the action that is about to be performed.
    259259         *
    260260         * @param {HTMLElement} list     The DOM element.
    261          * @param {object}      settings Settings for this list.
     261         * @param {Object}      settings Settings for this list.
    262262         * @param {string}      action   The type of action to perform: 'add', 'delete', or 'dim'.
    263          * @return {object|boolean} Settings if confirmed, false if not.
     263         * @return {Object|boolean} Settings if confirmed, false if not.
    264264         */
    265265        pre: function( list, settings, action ) {
    266266                var $element, backgroundColor, confirmed;
     
    297297         * Adds an item to the list via Ajax.
    298298         *
    299299         * @param {HTMLElement} element  The DOM element.
    300          * @param {object}      settings Settings for this list.
     300         * @param {Object}      settings Settings for this list.
    301301         * @return {boolean} Whether the item was added.
    302302         */
    303303        ajaxAdd: function( element, settings ) {
     
    399399         * Delete an item in the list via Ajax.
    400400         *
    401401         * @param {HTMLElement} element  A DOM element containing item data.
    402          * @param {object}      settings Settings for this list.
     402         * @param {Object}      settings Settings for this list.
    403403         * @return {boolean} Whether the item was deleted.
    404404         */
    405405        ajaxDel: function( element, settings ) {
     
    486486         * Dim an item in the list via Ajax.
    487487         *
    488488         * @param {HTMLElement} element  A DOM element containing item data.
    489          * @param {object}      settings Settings for this list.
     489         * @param {Object}      settings Settings for this list.
    490490         * @return {boolean} Whether the item was dim'ed.
    491491         */
    492492        ajaxDim: function( element, settings ) {
     
    621621         * Adds something.
    622622         *
    623623         * @param {HTMLElement} element  A DOM element containing item data.
    624          * @param {object}      settings Settings for this list.
     624         * @param {Object}      settings Settings for this list.
    625625         * @return {boolean} Whether the item was added.
    626626         */
    627627        add: function( element, settings ) {
  • src/js/_enqueues/lib/nav-menu.js

     
    429429                 * Refreshes advanced accessibility buttons for one menu item.
    430430                 * Shows or hides buttons based on the location of the menu item.
    431431                 *
    432                  * @param {object} itemToRefresh The menu item that might need its advanced accessibility buttons refreshed
     432                 * @param {Object} itemToRefresh The menu item that might need its advanced accessibility buttons refreshed
    433433                 */
    434434                refreshAdvancedAccessibilityOfItem : function( itemToRefresh ) {
    435435
     
    12931293                /**
    12941294                 * Remove a menu item.
    12951295                 *
    1296                  * @param {object} el The element to be removed as a jQuery object.
     1296                 * @param {Object} el The element to be removed as a jQuery object.
    12971297                 *
    12981298                 * @fires document#menu-removing-item Passes the element to be removed.
    12991299                 */
  • src/js/_enqueues/vendor/codemirror/csslint.js

     
    252252 * Represents a selector combinator (whitespace, +, >).
    253253 * @namespace parserlib.css
    254254 * @class Combinator
    255  * @extends parserlib.util.SyntaxUnit
     255 * @augments parserlib.util.SyntaxUnit
    256256 * @constructor
    257  * @param {String} text The text representation of the unit.
    258  * @param {int} line The line of text on which the unit resides.
    259  * @param {int} col The column of text on which the unit resides.
     257 * @param {string} text The text representation of the unit.
     258 * @param {number} line The line of text on which the unit resides.
     259 * @param {number} col The column of text on which the unit resides.
    260260 */
    261261function Combinator(text, line, col) {
    262262
     
    656656 * Represents a media feature, such as max-width:500.
    657657 * @namespace parserlib.css
    658658 * @class MediaFeature
    659  * @extends parserlib.util.SyntaxUnit
     659 * @augments parserlib.util.SyntaxUnit
    660660 * @constructor
    661661 * @param {SyntaxUnit} name The name of the feature.
    662662 * @param {SyntaxUnit} value The value of the feature or null if none.
     
    697697 * Represents an individual media query.
    698698 * @namespace parserlib.css
    699699 * @class MediaQuery
    700  * @extends parserlib.util.SyntaxUnit
     700 * @augments parserlib.util.SyntaxUnit
    701701 * @constructor
    702  * @param {String} modifier The modifier "not" or "only" (or null).
    703  * @param {String} mediaType The type of media (i.e., "print").
     702 * @param {string} modifier The modifier "not" or "only" (or null).
     703 * @param {string} mediaType The type of media (i.e., "print").
    704704 * @param {Array} parts Array of selectors parts making up this selector.
    705  * @param {int} line The line of text on which the unit resides.
    706  * @param {int} col The column of text on which the unit resides.
     705 * @param {number} line The line of text on which the unit resides.
     706 * @param {number} col The column of text on which the unit resides.
    707707 */
    708708function MediaQuery(modifier, mediaType, features, line, col) {
    709709
     
    30233023             * Not part of CSS grammar, but this pattern occurs frequently
    30243024             * in the official CSS grammar. Split out here to eliminate
    30253025             * duplicate code.
    3026              * @param {Boolean} checkStart Indicates if the rule should check
     3026             * @param {boolean} checkStart Indicates if the rule should check
    30273027             *      for the left brace at the beginning.
    3028              * @param {Boolean} readMargins Indicates if the rule should check
     3028             * @param {boolean} readMargins Indicates if the rule should check
    30293029             *      for margin patterns.
    30303030             * @return {void}
    30313031             * @method _readDeclarations
     
    31133113             * white space, this function is used to match as much white space
    31143114             * as necessary.
    31153115             * @method _readWhitespace
    3116              * @return {String} The white space if found, empty string if not.
     3116             * @return {string} The white space if found, empty string if not.
    31173117             * @private
    31183118             */
    31193119            _readWhitespace: function() {
     
    32103210            /**
    32113211             * Parses a complete CSS rule, including selectors and
    32123212             * properties.
    3213              * @param {String} input The text to parser.
    3214              * @return {Boolean} True if the parse completed successfully, false if not.
     3213             * @param {string} input The text to parser.
     3214             * @return {boolean} True if the parse completed successfully, false if not.
    32153215             * @method parseRule
    32163216             */
    32173217            parseRule: function(input) {
     
    32343234
    32353235            /**
    32363236             * Parses a single CSS selector (no comma)
    3237              * @param {String} input The text to parse as a CSS selector.
     3237             * @param {string} input The text to parse as a CSS selector.
    32383238             * @return {Selector} An object representing the selector.
    32393239             * @throws parserlib.util.SyntaxError If an unexpected token is found.
    32403240             * @method parseSelector
     
    32613261            /**
    32623262             * Parses an HTML style attribute: a set of CSS declarations
    32633263             * separated by semicolons.
    3264              * @param {String} input The text to parse as a style attribute
     3264             * @param {string} input The text to parse as a style attribute
    32653265             * @return {void}
    32663266             * @method parseStyleAttribute
    32673267             */
     
    37973797 * Represents a selector combinator (whitespace, +, >).
    37983798 * @namespace parserlib.css
    37993799 * @class PropertyName
    3800  * @extends parserlib.util.SyntaxUnit
     3800 * @augments parserlib.util.SyntaxUnit
    38013801 * @constructor
    3802  * @param {String} text The text representation of the unit.
    3803  * @param {String} hack The type of IE hack applied ("*", "_", or null).
    3804  * @param {int} line The line of text on which the unit resides.
    3805  * @param {int} col The column of text on which the unit resides.
     3802 * @param {string} text The text representation of the unit.
     3803 * @param {string} hack The type of IE hack applied ("*", "_", or null).
     3804 * @param {number} line The line of text on which the unit resides.
     3805 * @param {number} col The column of text on which the unit resides.
    38063806 */
    38073807function PropertyName(text, hack, line, col) {
    38083808
     
    38363836 * Represents a single part of a CSS property value, meaning that it represents
    38373837 * just everything single part between ":" and ";". If there are multiple values
    38383838 * separated by commas, this type represents just one of the values.
    3839  * @param {String[]} parts An array of value parts making up this value.
    3840  * @param {int} line The line of text on which the unit resides.
    3841  * @param {int} col The column of text on which the unit resides.
     3839 * @param {string[]} parts An array of value parts making up this value.
     3840 * @param {number} line The line of text on which the unit resides.
     3841 * @param {number} col The column of text on which the unit resides.
    38423842 * @namespace parserlib.css
    38433843 * @class PropertyValue
    3844  * @extends parserlib.util.SyntaxUnit
     3844 * @augments parserlib.util.SyntaxUnit
    38453845 * @constructor
    38463846 */
    38473847function PropertyValue(parts, line, col) {
     
    39113911
    39123912/**
    39133913 * Returns the total number of parts in the value.
    3914  * @return {int} The total number of parts in the value.
     3914 * @return {number} The total number of parts in the value.
    39153915 * @method count
    39163916 */
    39173917PropertyValueIterator.prototype.count = function() {
     
    39203920
    39213921/**
    39223922 * Indicates if the iterator is positioned at the first item.
    3923  * @return {Boolean} True if positioned at first item, false if not.
     3923 * @return {boolean} True if positioned at first item, false if not.
    39243924 * @method isFirst
    39253925 */
    39263926PropertyValueIterator.prototype.isFirst = function() {
     
    39293929
    39303930/**
    39313931 * Indicates if there are more parts of the property value.
    3932  * @return {Boolean} True if there are more parts, false if not.
     3932 * @return {boolean} True if there are more parts, false if not.
    39333933 * @method hasNext
    39343934 */
    39353935PropertyValueIterator.prototype.hasNext = function() {
     
    40134013/**
    40144014 * Represents a single part of a CSS property value, meaning that it represents
    40154015 * just one part of the data between ":" and ";".
    4016  * @param {String} text The text representation of the unit.
    4017  * @param {int} line The line of text on which the unit resides.
    4018  * @param {int} col The column of text on which the unit resides.
     4016 * @param {string} text The text representation of the unit.
     4017 * @param {number} line The line of text on which the unit resides.
     4018 * @param {number} col The column of text on which the unit resides.
    40194019 * @namespace parserlib.css
    40204020 * @class PropertyValuePart
    4021  * @extends parserlib.util.SyntaxUnit
     4021 * @augments parserlib.util.SyntaxUnit
    40224022 * @constructor
    40234023 */
    40244024function PropertyValuePart(text, line, col, optionalHint) {
     
    42814281 * including multiple selectors (those separated by commas).
    42824282 * @namespace parserlib.css
    42834283 * @class Selector
    4284  * @extends parserlib.util.SyntaxUnit
     4284 * @augments parserlib.util.SyntaxUnit
    42854285 * @constructor
    42864286 * @param {Array} parts Array of selectors parts making up this selector.
    4287  * @param {int} line The line of text on which the unit resides.
    4288  * @param {int} col The column of text on which the unit resides.
     4287 * @param {number} line The line of text on which the unit resides.
     4288 * @param {number} col The column of text on which the unit resides.
    42894289 */
    42904290function Selector(parts, line, col) {
    42914291
     
    43264326 * spaces, +, >, etc.
    43274327 * @namespace parserlib.css
    43284328 * @class SelectorPart
    4329  * @extends parserlib.util.SyntaxUnit
     4329 * @augments parserlib.util.SyntaxUnit
    43304330 * @constructor
    4331  * @param {String} elementName The element name in the selector or null
     4331 * @param {string} elementName The element name in the selector or null
    43324332 *      if there is no element name.
    43334333 * @param {Array} modifiers Array of individual modifiers for the element.
    43344334 *      May be empty if there are none.
    4335  * @param {String} text The text representation of the unit.
    4336  * @param {int} line The line of text on which the unit resides.
    4337  * @param {int} col The column of text on which the unit resides.
     4335 * @param {string} text The text representation of the unit.
     4336 * @param {number} line The line of text on which the unit resides.
     4337 * @param {number} col The column of text on which the unit resides.
    43384338 */
    43394339function SelectorPart(elementName, modifiers, text, line, col) {
    43404340
     
    43764376 * element ID, pseudo rule, etc.
    43774377 * @namespace parserlib.css
    43784378 * @class SelectorSubPart
    4379  * @extends parserlib.util.SyntaxUnit
     4379 * @augments parserlib.util.SyntaxUnit
    43804380 * @constructor
    4381  * @param {String} text The text representation of the unit.
    4382  * @param {String} type The type of selector modifier.
    4383  * @param {int} line The line of text on which the unit resides.
    4384  * @param {int} col The column of text on which the unit resides.
     4381 * @param {string} text The text representation of the unit.
     4382 * @param {string} type The type of selector modifier.
     4383 * @param {number} line The line of text on which the unit resides.
     4384 * @param {number} col The column of text on which the unit resides.
    43854385 */
    43864386function SelectorSubPart(text, type, line, col) {
    43874387
     
    44204420 * @namespace parserlib.css
    44214421 * @class Specificity
    44224422 * @constructor
    4423  * @param {int} a Should be 1 for inline styles, zero for stylesheet styles
    4424  * @param {int} b Number of ID selectors
    4425  * @param {int} c Number of classes and pseudo classes
    4426  * @param {int} d Number of element names and pseudo elements
     4423 * @param {number} a Should be 1 for inline styles, zero for stylesheet styles
     4424 * @param {number} b Number of ID selectors
     4425 * @param {number} c Number of classes and pseudo classes
     4426 * @param {number} d Number of element names and pseudo elements
    44274427 */
    44284428function Specificity(a, b, c, d) {
    44294429    this.a = a;
     
    44384438    /**
    44394439     * Compare this specificity to another.
    44404440     * @param {Specificity} other The other specificity to compare to.
    4441      * @return {int} -1 if the other specificity is larger, 1 if smaller, 0 if equal.
     4441     * @return {number} -1 if the other specificity is larger, 1 if smaller, 0 if equal.
    44424442     * @method compare
    44434443     */
    44444444    compare: function(other) {
     
    44584458
    44594459    /**
    44604460     * Creates a numeric value for the specificity.
    4461      * @return {int} The numeric value for the specificity.
     4461     * @return {number} The numeric value for the specificity.
    44624462     * @method valueOf
    44634463     */
    44644464    valueOf: function() {
     
    44674467
    44684468    /**
    44694469     * Returns a string representation for specificity.
    4470      * @return {String} The string representation of specificity.
     4470     * @return {string} The string representation of specificity.
    44714471     * @method toString
    44724472     */
    44734473    toString: function() {
     
    46024602
    46034603/**
    46044604 * A token stream that produces CSS tokens.
    4605  * @param {String|Reader} input The source of text to tokenize.
     4605 * @param {string|Reader} input The source of text to tokenize.
    46064606 * @constructor
    46074607 * @class TokenStream
    46084608 * @namespace parserlib.css
     
    48484848     * Produces a token based on available data and the current
    48494849     * reader position information. This method is called by other
    48504850     * private methods to create tokens and is never called directly.
    4851      * @param {int} tt The token type.
    4852      * @param {String} value The text value of the token.
    4853      * @param {int} startLine The beginning line for the character.
    4854      * @param {int} startCol The beginning column for the character.
     4851     * @param {number} tt The token type.
     4852     * @param {string} value The text value of the token.
     4853     * @param {number} startLine The beginning line for the character.
     4854     * @param {number} startCol The beginning column for the character.
    48554855     * @param {Object} options (Optional) Specifies a channel property
    48564856     *      to indicate that a different channel should be scanned
    48574857     *      and/or a hide property indicating that the token should
     
    48834883    /**
    48844884     * Produces a token for any at-rule. If the at-rule is unknown, then
    48854885     * the token is for a single "@" character.
    4886      * @param {String} first The first character for the token.
    4887      * @param {int} startLine The beginning line for the character.
    4888      * @param {int} startCol The beginning column for the character.
     4886     * @param {string} first The first character for the token.
     4887     * @param {number} startLine The beginning line for the character.
     4888     * @param {number} startCol The beginning column for the character.
    48894889     * @return {Object} A token object.
    48904890     * @method atRuleToken
    48914891     */
     
    49274927     * Produces a character token based on the given character
    49284928     * and location in the stream. If there's a special (non-standard)
    49294929     * token name, this is used; otherwise CHAR is used.
    4930      * @param {String} c The character for the token.
    4931      * @param {int} startLine The beginning line for the character.
    4932      * @param {int} startCol The beginning column for the character.
     4930     * @param {string} c The character for the token.
     4931     * @param {number} startLine The beginning line for the character.
     4932     * @param {number} startCol The beginning column for the character.
    49334933     * @return {Object} A token object.
    49344934     * @method charToken
    49354935     */
     
    49504950     * Produces a character token based on the given character
    49514951     * and location in the stream. If there's a special (non-standard)
    49524952     * token name, this is used; otherwise CHAR is used.
    4953      * @param {String} first The first character for the token.
    4954      * @param {int} startLine The beginning line for the character.
    4955      * @param {int} startCol The beginning column for the character.
     4953     * @param {string} first The first character for the token.
     4954     * @param {number} startLine The beginning line for the character.
     4955     * @param {number} startCol The beginning column for the character.
    49564956     * @return {Object} A token object.
    49574957     * @method commentToken
    49584958     */
     
    49664966     * Produces a comparison token based on the given character
    49674967     * and location in the stream. The next character must be
    49684968     * read and is already known to be an equals sign.
    4969      * @param {String} c The character for the token.
    4970      * @param {int} startLine The beginning line for the character.
    4971      * @param {int} startCol The beginning column for the character.
     4969     * @param {string} c The character for the token.
     4970     * @param {number} startLine The beginning line for the character.
     4971     * @param {number} startCol The beginning column for the character.
    49724972     * @return {Object} A token object.
    49734973     * @method comparisonToken
    49744974     */
     
    49844984     * Produces a hash token based on the specified information. The
    49854985     * first character provided is the pound sign (#) and then this
    49864986     * method reads a name afterward.
    4987      * @param {String} first The first character (#) in the hash name.
    4988      * @param {int} startLine The beginning line for the character.
    4989      * @param {int} startCol The beginning column for the character.
     4987     * @param {string} first The first character (#) in the hash name.
     4988     * @param {number} startLine The beginning line for the character.
     4989     * @param {number} startCol The beginning column for the character.
    49904990     * @return {Object} A token object.
    49914991     * @method hashToken
    49924992     */
     
    50005000     * Produces a CDO or CHAR token based on the specified information. The
    50015001     * first character is provided and the rest is read by the function to determine
    50025002     * the correct token to create.
    5003      * @param {String} first The first character in the token.
    5004      * @param {int} startLine The beginning line for the character.
    5005      * @param {int} startCol The beginning column for the character.
     5003     * @param {string} first The first character in the token.
     5004     * @param {number} startLine The beginning line for the character.
     5005     * @param {number} startCol The beginning column for the character.
    50065006     * @return {Object} A token object.
    50075007     * @method htmlCommentStartToken
    50085008     */
     
    50255025     * Produces a CDC or CHAR token based on the specified information. The
    50265026     * first character is provided and the rest is read by the function to determine
    50275027     * the correct token to create.
    5028      * @param {String} first The first character in the token.
    5029      * @param {int} startLine The beginning line for the character.
    5030      * @param {int} startCol The beginning column for the character.
     5028     * @param {string} first The first character in the token.
     5029     * @param {number} startLine The beginning line for the character.
     5030     * @param {number} startCol The beginning column for the character.
    50315031     * @return {Object} A token object.
    50325032     * @method htmlCommentEndToken
    50335033     */
     
    50505050     * Produces an IDENT or FUNCTION token based on the specified information. The
    50515051     * first character is provided and the rest is read by the function to determine
    50525052     * the correct token to create.
    5053      * @param {String} first The first character in the identifier.
    5054      * @param {int} startLine The beginning line for the character.
    5055      * @param {int} startCol The beginning column for the character.
     5053     * @param {string} first The first character in the identifier.
     5054     * @param {number} startLine The beginning line for the character.
     5055     * @param {number} startCol The beginning column for the character.
    50565056     * @return {Object} A token object.
    50575057     * @method identOrFunctionToken
    50585058     */
     
    50965096     * Produces an IMPORTANT_SYM or CHAR token based on the specified information. The
    50975097     * first character is provided and the rest is read by the function to determine
    50985098     * the correct token to create.
    5099      * @param {String} first The first character in the token.
    5100      * @param {int} startLine The beginning line for the character.
    5101      * @param {int} startCol The beginning column for the character.
     5099     * @param {string} first The first character in the token.
     5100     * @param {number} startLine The beginning line for the character.
     5101     * @param {number} startCol The beginning column for the character.
    51025102     * @return {Object} A token object.
    51035103     * @method importantToken
    51045104     */
     
    51575157     * Produces a NOT or CHAR token based on the specified information. The
    51585158     * first character is provided and the rest is read by the function to determine
    51595159     * the correct token to create.
    5160      * @param {String} first The first character in the token.
    5161      * @param {int} startLine The beginning line for the character.
    5162      * @param {int} startCol The beginning column for the character.
     5160     * @param {string} first The first character in the token.
     5161     * @param {number} startLine The beginning line for the character.
     5162     * @param {number} startCol The beginning column for the character.
    51635163     * @return {Object} A token object.
    51645164     * @method notToken
    51655165     */
     
    51835183     * and location in the stream. This may return a token of
    51845184     * NUMBER, EMS, EXS, LENGTH, ANGLE, TIME, FREQ, DIMENSION,
    51855185     * or PERCENTAGE.
    5186      * @param {String} first The first character for the token.
    5187      * @param {int} startLine The beginning line for the character.
    5188      * @param {int} startCol The beginning column for the character.
     5186     * @param {string} first The first character for the token.
     5187     * @param {number} startLine The beginning line for the character.
     5188     * @param {number} startCol The beginning column for the character.
    51895189     * @return {Object} A token object.
    51905190     * @method numberToken
    51915191     */
     
    52295229     * and ending quotes results in an INVALID token being generated.
    52305230     * The first character in the string is passed in and then
    52315231     * the rest are read up to and including the final quotation mark.
    5232      * @param {String} first The first character in the string.
    5233      * @param {int} startLine The beginning line for the character.
    5234      * @param {int} startCol The beginning column for the character.
     5232     * @param {string} first The first character in the string.
     5233     * @param {number} startLine The beginning line for the character.
     5234     * @param {number} startCol The beginning column for the character.
    52355235     * @return {Object} A token object.
    52365236     * @method stringToken
    52375237     */
     
    53365336     * Produces a S token based on the specified information. Since whitespace
    53375337     * may have multiple characters, this consumes all whitespace characters
    53385338     * into a single token.
    5339      * @param {String} first The first character in the token.
    5340      * @param {int} startLine The beginning line for the character.
    5341      * @param {int} startCol The beginning column for the character.
     5339     * @param {string} first The first character in the token.
     5340     * @param {number} startLine The beginning line for the character.
     5341     * @param {number} startCol The beginning column for the character.
    53425342     * @return {Object} A token object.
    53435343     * @method whitespaceToken
    53445344     */
     
    58765876 * @class ValidationError
    58775877 * @namespace parserlib.util
    58785878 * @constructor
    5879  * @param {String} message The error message.
    5880  * @param {int} line The line at which the error occurred.
    5881  * @param {int} col The column at which the error occurred.
     5879 * @param {string} message The error message.
     5880 * @param {number} line The line at which the error occurred.
     5881 * @param {number} col The column at which the error occurred.
    58825882 */
    58835883function ValidationError(message, line, col) {
    58845884
     
    64386438
    64396439    /**
    64406440     * Adds a listener for a given event type.
    6441      * @param {String} type The type of event to add a listener for.
     6441     * @param {string} type The type of event to add a listener for.
    64426442     * @param {Function} listener The function to call when the event occurs.
    64436443     * @return {void}
    64446444     * @method addListener
     
    64536453
    64546454    /**
    64556455     * Fires an event based on the passed-in object.
    6456      * @param {Object|String} event An object with at least a 'type' attribute
     6456     * @param {Object|string} event An object with at least a 'type' attribute
    64576457     *      or a string indicating the event name.
    64586458     * @return {void}
    64596459     * @method fire
     
    64826482
    64836483    /**
    64846484     * Removes a listener for a given event type.
    6485      * @param {String} type The type of event to remove a listener from.
     6485     * @param {string} type The type of event to remove a listener from.
    64866486     * @param {Function} listener The function to remove from the event.
    64876487     * @return {void}
    64886488     * @method removeListener
     
    65126512 * @namespace parserlib.util
    65136513 * @class StringReader
    65146514 * @constructor
    6515  * @param {String} text The text to read.
     6515 * @param {string} text The text to read.
    65166516 */
    65176517function StringReader(text) {
    65186518
     
    65626562
    65636563    /**
    65646564     * Returns the column of the character to be read next.
    6565      * @return {int} The column of the character to be read next.
     6565     * @return {number} The column of the character to be read next.
    65666566     * @method getCol
    65676567     */
    65686568    getCol: function() {
     
    65716571
    65726572    /**
    65736573     * Returns the row of the character to be read next.
    6574      * @return {int} The row of the character to be read next.
     6574     * @return {number} The row of the character to be read next.
    65756575     * @method getLine
    65766576     */
    65776577    getLine: function() {
     
    65806580
    65816581    /**
    65826582     * Determines if you're at the end of the input.
    6583      * @return {Boolean} True if there's no more input, false otherwise.
     6583     * @return {boolean} True if there's no more input, false otherwise.
    65846584     * @method eof
    65856585     */
    65866586    eof: function() {
     
    65936593
    65946594    /**
    65956595     * Reads the next character without advancing the cursor.
    6596      * @param {int} count How many characters to look ahead (default is 1).
    6597      * @return {String} The next character or null if there is no next character.
     6596     * @param {number} count How many characters to look ahead (default is 1).
     6597     * @return {string} The next character or null if there is no next character.
    65986598     * @method peek
    65996599     */
    66006600    peek: function(count) {
     
    66146614    /**
    66156615     * Reads the next character from the input and adjusts the row and column
    66166616     * accordingly.
    6617      * @return {String} The next character or null if there is no next character.
     6617     * @return {string} The next character or null if there is no next character.
    66186618     * @method read
    66196619     */
    66206620    read: function() {
     
    66726672    /**
    66736673     * Reads up to and including the given string. Throws an error if that
    66746674     * string is not found.
    6675      * @param {String} pattern The string to read.
    6676      * @return {String} The string when it is found.
     6675     * @param {string} pattern The string to read.
     6676     * @return {string} The string when it is found.
    66776677     * @throws Error when the string pattern is not found.
    66786678     * @method readTo
    66796679     */
     
    67066706     * in each character and either returns true to continue
    67076707     * reading or false to stop.
    67086708     * @param {Function} filter The function to read on each character.
    6709      * @return {String} The string made up of all characters that passed the
     6709     * @return {string} The string made up of all characters that passed the
    67106710     *      filter check.
    67116711     * @method readWhile
    67126712     */
     
    67296729     * returns those characters. If a match is found, the row and column
    67306730     * are adjusted; if no match is found, the reader's state is unchanged.
    67316731     * reading or false to stop.
    6732      * @param {String|RegExp} matcher If a string, then the literal string
     6732     * @param {string|RegExp} matcher If a string, then the literal string
    67336733     *      value is searched for. If a regular expression, then any string
    67346734     *      matching the pattern is search for.
    6735      * @return {String} The string made up of all characters that matched or
     6735     * @return {string} The string made up of all characters that matched or
    67366736     *      null if there was no match.
    67376737     * @method readMatch
    67386738     */
     
    67596759    /**
    67606760     * Reads a given number of characters. If the end of the input is reached,
    67616761     * it reads only the remaining characters and does not throw an error.
    6762      * @param {int} count The number of characters to read.
    6763      * @return {String} The string made up the read characters.
     6762     * @param {number} count The number of characters to read.
     6763     * @return {string} The string made up the read characters.
    67646764     * @method readCount
    67656765     */
    67666766    readCount: function(count) {
     
    67856785 * @class SyntaxError
    67866786 * @namespace parserlib.util
    67876787 * @constructor
    6788  * @param {String} message The error message.
    6789  * @param {int} line The line at which the error occurred.
    6790  * @param {int} col The column at which the error occurred.
     6788 * @param {string} message The error message.
     6789 * @param {number} line The line at which the error occurred.
     6790 * @param {number} col The column at which the error occurred.
    67916791 */
    67926792function SyntaxError(message, line, col) {
    67936793    Error.call(this);
     
    68306830 * @class SyntaxUnit
    68316831 * @namespace parserlib.util
    68326832 * @constructor
    6833  * @param {String} text The text of the unit.
    6834  * @param {int} line The line of text on which the unit resides.
    6835  * @param {int} col The column of text on which the unit resides.
     6833 * @param {string} text The text of the unit.
     6834 * @param {number} line The line of text on which the unit resides.
     6835 * @param {number} col The column of text on which the unit resides.
    68366836 */
    68376837function SyntaxUnit(text, line, col, type) {
    68386838
     
    68866886
    68876887    /**
    68886888     * Returns the text representation of the unit.
    6889      * @return {String} The text representation of the unit.
     6889     * @return {string} The text representation of the unit.
    68906890     * @method valueOf
    68916891     */
    68926892    valueOf: function() {
     
    68956895
    68966896    /**
    68976897     * Returns the text representation of the unit.
    6898      * @return {String} The text representation of the unit.
     6898     * @return {string} The text representation of the unit.
    68996899     * @method toString
    69006900     */
    69016901    toString: function() {
     
    69176917 * @class TokenStreamBase
    69186918 * @namespace parserlib.util
    69196919 * @constructor
    6920  * @param {String|StringReader} input The text to tokenize or a reader from
     6920 * @param {string|StringReader} input The text to tokenize or a reader from
    69216921 *      which to read the input.
    69226922 */
    69236923function TokenStreamBase(input, tokenData) {
     
    70197019     * back onto the token stream. You can pass in any number of
    70207020     * token types and this will return true if any of the token
    70217021     * types is found.
    7022      * @param {int|int[]} tokenTypes Either a single token type or an array of
     7022     * @param {number|number[]} tokenTypes Either a single token type or an array of
    70237023     *      token types that the next token might be. If an array is passed,
    70247024     *      it's assumed that the token can be any of these.
    70257025     * @param {variant} channel (Optional) The channel to read from. If not
    70267026     *      provided, reads from the default (unnamed) channel.
    7027      * @return {Boolean} True if the token type matches, false if not.
     7027     * @return {boolean} True if the token type matches, false if not.
    70287028     * @method match
    70297029     */
    70307030    match: function(tokenTypes, channel) {
     
    70527052    /**
    70537053     * Determines if the next token matches the given token type.
    70547054     * If so, that token is consumed; if not, an error is thrown.
    7055      * @param {int|int[]} tokenTypes Either a single token type or an array of
     7055     * @param {number|number[]} tokenTypes Either a single token type or an array of
    70567056     *      token types that the next token should be. If an array is passed,
    70577057     *      it's assumed that the token must be one of these.
    70587058     * @return {void}
     
    70817081    /**
    70827082     * Keeps reading from the token stream until either one of the specified
    70837083     * token types is found or until the end of the input is reached.
    7084      * @param {int|int[]} tokenTypes Either a single token type or an array of
     7084     * @param {number|number[]} tokenTypes Either a single token type or an array of
    70857085     *      token types that the next token should be. If an array is passed,
    70867086     *      it's assumed that the token must be one of these.
    70877087     * @param {variant} channel (Optional) The channel to read from. If not
     
    71007100
    71017101    /**
    71027102     * Consumes the next token from the token stream.
    7103      * @return {int} The token type of the token that was just consumed.
     7103     * @return {number} The token type of the token that was just consumed.
    71047104     * @method get
    71057105     */
    71067106    get: function(channel) {
     
    71847184     * that position. This will throw an error if you lookahead past the
    71857185     * end of input, past the size of the lookahead buffer, or back past
    71867186     * the first token in the lookahead buffer.
    7187      * @param {int} The index of the token type to retrieve. 0 for the
     7187     * @param {number} The index of the token type to retrieve. 0 for the
    71887188     *      current token, 1 for the next, -1 for the previous, etc.
    7189      * @return {int} The token type of the token in the given position.
     7189     * @return {number} The token type of the token in the given position.
    71907190     * @method LA
    71917191     */
    71927192    LA: function(index) {
     
    72307230     * that position. This will throw an error if you lookahead past the
    72317231     * end of input, past the size of the lookahead buffer, or back past
    72327232     * the first token in the lookahead buffer.
    7233      * @param {int} The index of the token type to retrieve. 0 for the
     7233     * @param {number} The index of the token type to retrieve. 0 for the
    72347234     *      current token, 1 for the next, -1 for the previous, etc.
    72357235     * @return {Object} The token of the token in the given position.
    72367236     * @method LA
     
    72477247    /**
    72487248     * Returns the token type for the next token in the stream without
    72497249     * consuming it.
    7250      * @return {int} The token type of the next token in the stream.
     7250     * @return {number} The token type of the next token in the stream.
    72517251     * @method peek
    72527252     */
    72537253    peek: function() {
     
    72657265
    72667266    /**
    72677267     * Returns the name of the token for the given token type.
    7268      * @param {int} tokenType The type of token to get the name of.
    7269      * @return {String} The name of the token or "UNKNOWN_TOKEN" for any
     7268     * @param {number} tokenType The type of token to get the name of.
     7269     * @return {string} The name of the token or "UNKNOWN_TOKEN" for any
    72707270     *      invalid token type.
    72717271     * @method tokenName
    72727272     */
     
    72807280
    72817281    /**
    72827282     * Returns the token type value for the given token name.
    7283      * @param {String} tokenName The name of the token whose value should be returned.
    7284      * @return {int} The token type value for the given token name or -1
     7283     * @param {string} tokenName The name of the token whose value should be returned.
     7284     * @return {number} The token type value for the given token name or -1
    72857285     *      for an unknown token.
    72867286     * @method tokenName
    72877287     */
     
    76597659
    76607660    /**
    76617661     * Returns a ruleset object based on embedded rules.
    7662      * @param {String} text A string of css containing embedded rules.
     7662     * @param {string} text A string of css containing embedded rules.
    76637663     * @param {Object} ruleset A ruleset object to modify.
    76647664     * @return {Object} A ruleset object.
    76657665     * @method getEmbeddedRuleset
     
    77087708
    77097709    /**
    77107710     * Retrieves a formatter for use.
    7711      * @param {String} formatId The name of the format to retrieve.
     7711     * @param {string} formatId The name of the format to retrieve.
    77127712     * @return {Object} The formatter or undefined.
    77137713     * @method getFormatter
    77147714     */
     
    77197719    /**
    77207720     * Formats the results in a particular format for a single file.
    77217721     * @param {Object} result The results returned from CSSLint.verify().
    7722      * @param {String} filename The filename for which the results apply.
    7723      * @param {String} formatId The name of the formatter to use.
     7722     * @param {string} filename The filename for which the results apply.
     7723     * @param {string} formatId The name of the formatter to use.
    77247724     * @param {Object} options (Optional) for special output handling.
    7725      * @return {String} A formatted string for the results.
     7725     * @return {string} A formatted string for the results.
    77267726     * @method format
    77277727     */
    77287728    api.format = function(results, filename, formatId, options) {
     
    77407740
    77417741    /**
    77427742     * Indicates if the given format is supported.
    7743      * @param {String} formatId The ID of the format to check.
    7744      * @return {Boolean} True if the format exists, false if not.
     7743     * @param {string} formatId The ID of the format to check.
     7744     * @return {boolean} True if the format exists, false if not.
    77457745     * @method hasFormat
    77467746     */
    77477747    api.hasFormat = function(formatId) {
     
    77547754
    77557755    /**
    77567756     * Starts the verification process for the given CSS text.
    7757      * @param {String} text The CSS text to verify.
     7757     * @param {string} text The CSS text to verify.
    77587758     * @param {Object} ruleset (Optional) List of rules to apply. If null, then
    77597759     *      all rules are used. If a rule has a value of 1 then it's a warning,
    77607760     *      a value of 2 means it's an error.
     
    78827882 * verification back to the main API.
    78837883 * @class Reporter
    78847884 * @constructor
    7885  * @param {String[]} lines The text lines of the source.
     7885 * @param {string[]} lines The text lines of the source.
    78867886 * @param {Object} ruleset The set of rules to work with, including if
    78877887 *      they are errors or warnings.
    78887888 * @param {Object} explicitly allowed lines
     
    79497949
    79507950    /**
    79517951     * Report an error.
    7952      * @param {String} message The message to store.
    7953      * @param {int} line The line number.
    7954      * @param {int} col The column number.
     7952     * @param {string} message The message to store.
     7953     * @param {number} line The line number.
     7954     * @param {number} col The column number.
    79557955     * @param {Object} rule The rule this message relates to.
    79567956     * @method error
    79577957     */
     
    79697969
    79707970    /**
    79717971     * Report an warning.
    7972      * @param {String} message The message to store.
    7973      * @param {int} line The line number.
    7974      * @param {int} col The column number.
     7972     * @param {string} message The message to store.
     7973     * @param {number} line The line number.
     7974     * @param {number} col The column number.
    79757975     * @param {Object} rule The rule this message relates to.
    79767976     * @method warn
    79777977     * @deprecated Use report instead.
     
    79837983
    79847984    /**
    79857985     * Report an issue.
    7986      * @param {String} message The message to store.
    7987      * @param {int} line The line number.
    7988      * @param {int} col The column number.
     7986     * @param {string} message The message to store.
     7987     * @param {number} line The line number.
     7988     * @param {number} col The column number.
    79897989     * @param {Object} rule The rule this message relates to.
    79907990     * @method report
    79917991     */
     
    80198019
    80208020    /**
    80218021     * Report some informational text.
    8022      * @param {String} message The message to store.
    8023      * @param {int} line The line number.
    8024      * @param {int} col The column number.
     8022     * @param {string} message The message to store.
     8023     * @param {number} line The line number.
     8024     * @param {number} col The column number.
    80258025     * @param {Object} rule The rule this message relates to.
    80268026     * @method info
    80278027     */
     
    80398039
    80408040    /**
    80418041     * Report some rollup error information.
    8042      * @param {String} message The message to store.
     8042     * @param {string} message The message to store.
    80438043     * @param {Object} rule The rule this message relates to.
    80448044     * @method rollupError
    80458045     */
     
    80558055
    80568056    /**
    80578057     * Report some rollup warning information.
    8058      * @param {String} message The message to store.
     8058     * @param {string} message The message to store.
    80598059     * @param {Object} rule The rule this message relates to.
    80608060     * @method rollupWarn
    80618061     */
     
    80718071
    80728072    /**
    80738073     * Report a statistic.
    8074      * @param {String} name The name of the stat to store.
     8074     * @param {string} name The name of the stat to store.
    80758075     * @param {Variant} value The value of the stat.
    80768076     * @method stat
    80778077     */
     
    1031410314     *  - &lt; is the escape sequence for <
    1031510315     *  - &gt; is the escape sequence for >
    1031610316     *
    10317      * @param {String} message to escape
     10317     * @param {string} message to escape
    1031810318     * @return escaped message as {String}
    1031910319     */
    1032010320    var xmlEscape = function(str) {
     
    1034310343
    1034410344        /**
    1034510345         * Return opening root XML tag.
    10346          * @return {String} to prepend before all results
     10346         * @return {string} to prepend before all results
    1034710347         */
    1034810348        startFormat: function() {
    1034910349            return "<?xml version=\"1.0\" encoding=\"utf-8\"?><checkstyle>";
     
    1035110351
    1035210352        /**
    1035310353         * Return closing root XML tag.
    10354          * @return {String} to append after all results
     10354         * @return {string} to append after all results
    1035510355         */
    1035610356        endFormat: function() {
    1035710357            return "</checkstyle>";
     
    1035910359
    1036010360        /**
    1036110361         * Returns message when there is a file read error.
    10362          * @param {String} filename The name of the file that caused the error.
    10363          * @param {String} message The error message
    10364          * @return {String} The error message.
     10362         * @param {string} filename The name of the file that caused the error.
     10363         * @param {string} message The error message
     10364         * @return {string} The error message.
    1036510365         */
    1036610366        readError: function(filename, message) {
    1036710367            return "<file name=\"" + xmlEscape(filename) + "\"><error line=\"0\" column=\"0\" severty=\"error\" message=\"" + xmlEscape(message) + "\"></error></file>";
     
    1037210372         * @param results {Object} with error and warning messages
    1037310373         * @param filename {String} relative file path
    1037410374         * @param options {Object} (UNUSED for now) specifies special handling of output
    10375          * @return {String} output for results
     10375         * @return {string} output for results
    1037610376         */
    1037710377        formatResults: function(results, filename/*, options*/) {
    1037810378            var messages = results.messages,
     
    1041810418
    1041910419    /**
    1042010420     * Return content to be printed before all file results.
    10421      * @return {String} to prepend before all results
     10421     * @return {string} to prepend before all results
    1042210422     */
    1042310423    startFormat: function() {
    1042410424        "use strict";
     
    1042710427
    1042810428    /**
    1042910429     * Return content to be printed after all file results.
    10430      * @return {String} to append after all results
     10430     * @return {string} to append after all results
    1043110431     */
    1043210432    endFormat: function() {
    1043310433        "use strict";
     
    1043910439     * @param results {Object} with error and warning messages
    1044010440     * @param filename {String} relative file path
    1044110441     * @param options {Object} (Optional) specifies special handling of output
    10442      * @return {String} output for results
     10442     * @return {string} output for results
    1044310443     */
    1044410444    formatResults: function(results, filename, options) {
    1044510445        "use strict";
     
    1045010450        /**
    1045110451         * Capitalize and return given string.
    1045210452         * @param str {String} to capitalize
    10453          * @return {String} capitalized
     10453         * @return {string} capitalized
    1045410454         */
    1045510455        var capitalize = function(str) {
    1045610456            return str.charAt(0).toUpperCase() + str.slice(1);
     
    1048010480
    1048110481    /**
    1048210482     * Return opening root XML tag.
    10483      * @return {String} to prepend before all results
     10483     * @return {string} to prepend before all results
    1048410484     */
    1048510485    startFormat: function() {
    1048610486        "use strict";
     
    1048910489
    1049010490    /**
    1049110491     * Return closing root XML tag.
    10492      * @return {String} to append after all results
     10492     * @return {string} to append after all results
    1049310493     */
    1049410494    endFormat: function() {
    1049510495        "use strict";
     
    1050110501     * @param results {Object} with error and warning messages
    1050210502     * @param filename {String} relative file path
    1050310503     * @param options {Object} (UNUSED for now) specifies special handling of output
    10504      * @return {String} output for results
     10504     * @return {string} output for results
    1050510505     */
    1050610506    formatResults: function(results, filename/*, options*/) {
    1050710507        "use strict";
     
    1051710517         *  - &lt; is the escape sequence for <
    1051810518         *  - &gt; is the escape sequence for >
    1051910519         *
    10520          * @param {String} message to escape
     10520         * @param {string} message to escape
    1052110521         * @return escaped message as {String}
    1052210522         */
    1052310523        var escapeSpecialCharacters = function(str) {
     
    1055310553
    1055410554    /**
    1055510555     * Return content to be printed before all file results.
    10556      * @return {String} to prepend before all results
     10556     * @return {string} to prepend before all results
    1055710557     */
    1055810558    startFormat: function() {
    1055910559        "use strict";
     
    1056310563
    1056410564    /**
    1056510565     * Return content to be printed after all file results.
    10566      * @return {String} to append after all results
     10566     * @return {string} to append after all results
    1056710567     */
    1056810568    endFormat: function() {
    1056910569        "use strict";
     
    1058210582     * Given CSS Lint results for a file, return output for this format.
    1058310583     * @param results {Object} with error and warning messages
    1058410584     * @param filename {String} relative file path (Unused)
    10585      * @return {String} output for results
     10585     * @return {string} output for results
    1058610586     */
    1058710587    formatResults: function(results, filename, options) {
    1058810588        "use strict";
     
    1060410604
    1060510605    /**
    1060610606     * Return opening root XML tag.
    10607      * @return {String} to prepend before all results
     10607     * @return {string} to prepend before all results
    1060810608     */
    1060910609    startFormat: function() {
    1061010610        "use strict";
     
    1061310613
    1061410614    /**
    1061510615     * Return closing root XML tag.
    10616      * @return {String} to append after all results
     10616     * @return {string} to append after all results
    1061710617     */
    1061810618    endFormat: function() {
    1061910619        "use strict";
     
    1062510625     * @param results {Object} with error and warning messages
    1062610626     * @param filename {String} relative file path
    1062710627     * @param options {Object} (UNUSED for now) specifies special handling of output
    10628      * @return {String} output for results
     10628     * @return {string} output for results
    1062910629     */
    1063010630    formatResults: function(results, filename/*, options*/) {
    1063110631        "use strict";
     
    1065910659         *  - &lt; is the escape sequence for <
    1066010660         *  - &gt; is the escape sequence for >
    1066110661         *
    10662          * @param {String} message to escape
     10662         * @param {string} message to escape
    1066310663         * @return escaped message as {String}
    1066410664         */
    1066510665        var escapeSpecialCharacters = function(str) {
     
    1071210712
    1071310713    /**
    1071410714     * Return opening root XML tag.
    10715      * @return {String} to prepend before all results
     10715     * @return {string} to prepend before all results
    1071610716     */
    1071710717    startFormat: function() {
    1071810718        "use strict";
     
    1072110721
    1072210722    /**
    1072310723     * Return closing root XML tag.
    10724      * @return {String} to append after all results
     10724     * @return {string} to append after all results
    1072510725     */
    1072610726    endFormat: function() {
    1072710727        "use strict";
     
    1073310733     * @param results {Object} with error and warning messages
    1073410734     * @param filename {String} relative file path
    1073510735     * @param options {Object} (UNUSED for now) specifies special handling of output
    10736      * @return {String} output for results
     10736     * @return {string} output for results
    1073710737     */
    1073810738    formatResults: function(results, filename/*, options*/) {
    1073910739        "use strict";
     
    1074910749         *  - &lt; is the escape sequence for <
    1075010750         *  - &gt; is the escape sequence for >
    1075110751         *
    10752          * @param {String} message to escape
     10752         * @param {string} message to escape
    1075310753         * @return escaped message as {String}
    1075410754         */
    1075510755        var escapeSpecialCharacters = function(str) {
     
    1078810788
    1078910789    /**
    1079010790     * Return content to be printed before all file results.
    10791      * @return {String} to prepend before all results
     10791     * @return {string} to prepend before all results
    1079210792     */
    1079310793    startFormat: function() {
    1079410794        "use strict";
     
    1079710797
    1079810798    /**
    1079910799     * Return content to be printed after all file results.
    10800      * @return {String} to append after all results
     10800     * @return {string} to append after all results
    1080110801     */
    1080210802    endFormat: function() {
    1080310803        "use strict";
     
    1080910809     * @param results {Object} with error and warning messages
    1081010810     * @param filename {String} relative file path
    1081110811     * @param options {Object} (Optional) specifies special handling of output
    10812      * @return {String} output for results
     10812     * @return {string} output for results
    1081310813     */
    1081410814    formatResults: function(results, filename, options) {
    1081510815        "use strict";
  • src/js/_enqueues/vendor/mediaelement/wp-mediaelement.js

     
    5252                         *
    5353                         * @since 4.9.3
    5454                         *
    55                          * @param {object} media The wrapper that mimics all the native events/properties/methods for all renderers.
    56                          * @param {object} node  The original HTML video, audio, or iframe tag where the media was loaded.
     55                         * @param {Object} media The wrapper that mimics all the native events/properties/methods for all renderers.
     56                         * @param {Object} node  The original HTML video, audio, or iframe tag where the media was loaded.
    5757                         * @return {string}
    5858                         */
    5959                        settings.customError = function ( media, node ) {
  • src/js/_enqueues/vendor/plupload/moxie.js

     
    119119        @for Utils
    120120        @static
    121121        @param {Object} o Object to check.
    122         @return {String} Object [[Class]]
     122        @return {string} Object [[Class]]
    123123        */
    124124        var typeOf = function(o) {
    125125                var undef;
     
    203203        @method isEmptyObj
    204204        @static
    205205        @param {Object} o Object to check.
    206         @return {Boolean}
     206        @return {boolean}
    207207        */
    208208        var isEmptyObj = function(obj) {
    209209                var prop;
     
    322322        @method arrayDiff
    323323        @param {Array} needles
    324324        @param {Array} array
    325         @return {Array|Boolean}
     325        @return {Array|boolean}
    326326        */
    327327        var arrayDiff = function(needles, array) {
    328328                var diff = [];
     
    415415       
    416416        @method trim
    417417        @static
    418         @param {String} str
    419         @return {String}
     418        @param {string} str
     419        @return {string}
    420420        */
    421421        var trim = function(str) {
    422422                if (!str) {
     
    432432        @method parseSizeStr
    433433        @static
    434434        @param {String/Number} size String to parse or number to just pass through.
    435         @return {Number} Size in bytes.
     435        @return {number} Size in bytes.
    436436        */
    437437        var parseSizeStr = function(size) {
    438438                if (typeof(size) !== 'string') {
     
    462462        /**
    463463         * Pseudo sprintf implementation - simple way to replace tokens with specified values.
    464464         *
    465          * @param {String} str String with tokens
    466          * @return {String} String with replaced tokens
     465         * @param {string} str String with tokens
     466         * @return {string} String with replaced tokens
    467467         */
    468468        var sprintf = function(str) {
    469469                var args = [].slice.call(arguments, 1);
     
    12291229                /**
    12301230                 * Translates the specified string by checking for the english string in the language pack lookup.
    12311231                 *
    1232                  * @param {String} str String to look for.
    1233                  * @return {String} Translated string or the input string if it wasn't found.
     1232                 * @param {string} str String to look for.
     1233                 * @return {string} Translated string or the input string if it wasn't found.
    12341234                 */
    12351235                translate: function(str) {
    12361236                        return i18n[str] || str;
     
    12391239                /**
    12401240                 * Shortcut for translate function
    12411241                 *
    1242                  * @param {String} str String to look for.
    1243                  * @return {String} Translated string or the input string if it wasn't found.
     1242                 * @param {string} str String to look for.
     1243                 * @return {string} Translated string or the input string if it wasn't found.
    12441244                 */
    12451245                _: function(str) {
    12461246                        return this.translate(str);
     
    12491249                /**
    12501250                 * Pseudo sprintf implementation - simple way to replace tokens with specified values.
    12511251                 *
    1252                  * @param {String} str String with tokens
    1253                  * @return {String} String with replaced tokens
     1252                 * @param {string} str String with tokens
     1253                 * @return {string} String with replaced tokens
    12541254                 */
    12551255                sprintf: function(str) {
    12561256                        var args = [].slice.call(arguments, 1);
     
    14771477
    14781478        @method get
    14791479        @for Utils
    1480         @param {String} id Identifier of the DOM Element
     1480        @param {string} id Identifier of the DOM Element
    14811481        @return {DOMElement}
    14821482        */
    14831483        var get = function(id) {
     
    14931493        @method hasClass
    14941494        @static
    14951495        @param {Object} obj DOM element like object to add handler to.
    1496         @param {String} name Class name
     1496        @param {string} name Class name
    14971497        */
    14981498        var hasClass = function(obj, name) {
    14991499                if (!obj.className) {
     
    15101510        @method addClass
    15111511        @static
    15121512        @param {Object} obj DOM element like object to add handler to.
    1513         @param {String} name Class name
     1513        @param {string} name Class name
    15141514        */
    15151515        var addClass = function(obj, name) {
    15161516                if (!hasClass(obj, name)) {
     
    15241524        @method removeClass
    15251525        @static
    15261526        @param {Object} obj DOM element like object to add handler to.
    1527         @param {String} name Class name
     1527        @param {string} name Class name
    15281528        */
    15291529        var removeClass = function(obj, name) {
    15301530                if (obj.className) {
     
    15411541        @method getStyle
    15421542        @static
    15431543        @param {Object} obj DOM element like object.
    1544         @param {String} name Style you want to get from the DOM element
     1544        @param {string} name Style you want to get from the DOM element
    15451545        */
    15461546        var getStyle = function(obj, name) {
    15471547                if (obj.currentStyle) {
     
    15591559        @static
    15601560        @param {Element} node HTML element or element id to get x, y position from.
    15611561        @param {Element} root Optional root element to stop calculations at.
    1562         @return {object} Absolute position of the specified element object with x, y fields.
     1562        @return {Object} Absolute position of the specified element object with x, y fields.
    15631563        */
    15641564        var getPos = function(node, root) {
    15651565                var x = 0, y = 0, parent, doc = document, nodeRect, rootRect;
     
    18521852                        Register a handler to a specific event dispatched by the object
    18531853
    18541854                        @method addEventListener
    1855                         @param {String} type Type or basically a name of the event to subscribe to
     1855                        @param {string} type Type or basically a name of the event to subscribe to
    18561856                        @param {Function} fn Callback function that will be called when event happens
    1857                         @param {Number} [priority=0] Priority of the event handler - handlers with higher priorities will be called first
     1857                        @param {number} [priority=0] Priority of the event handler - handlers with higher priorities will be called first
    18581858                        @param {Object} [scope=this] A scope to invoke event handler in
    18591859                        */
    18601860                        addEventListener: function(type, fn, priority, scope) {
     
    18911891                        Check if any handlers were registered to the specified event
    18921892
    18931893                        @method hasEventListener
    1894                         @param {String} type Type or basically a name of the event to check
     1894                        @param {string} type Type or basically a name of the event to check
    18951895                        @return {Mixed} Returns a handler if it was found and false, if - not
    18961896                        */
    18971897                        hasEventListener: function(type) {
     
    19031903                        Unregister the handler from the event, or if former was not specified - unregister all handlers
    19041904
    19051905                        @method removeEventListener
    1906                         @param {String} type Type or basically a name of the event
     1906                        @param {string} type Type or basically a name of the event
    19071907                        @param {Function} [fn] Handler to unregister
    19081908                        */
    19091909                        removeEventListener: function(type, fn) {
     
    19521952                        @method dispatchEvent
    19531953                        @param {String/Object} Type of event or event object to dispatch
    19541954                        @param {Mixed} [...] Variable number of arguments to be passed to a handlers
    1955                         @return {Boolean} true by default and false if any handler returned false
     1955                        @return {boolean} true by default and false if any handler returned false
    19561956                        */
    19571957                        dispatchEvent: function(type) {
    19581958                                var uid, list, args, tmpEvt, evt = {}, result = true, undef;
     
    21302130        @class Runtime
    21312131
    21322132        @param {Object} options
    2133         @param {String} type Sanitized name of the runtime
     2133        @param {string} type Sanitized name of the runtime
    21342134        @param {Object} [caps] Set of capabilities that differentiate specified runtime
    21352135        @param {Object} [modeCaps] Set of capabilities that do require specific operational mode
    2136         @param {String} [preferredMode='browser'] Preferred operational mode to choose if no required capabilities were requested
     2136        @param {string} [preferredMode='browser'] Preferred operational mode to choose if no required capabilities were requested
    21372137        */
    21382138        function Runtime(options, type, caps, modeCaps, preferredMode) {
    21392139                /**
     
    23302330                        Checks if the runtime has specific capability
    23312331
    23322332                        @method can
    2333                         @param {String} cap Name of capability to check
     2333                        @param {string} cap Name of capability to check
    23342334                        @param {Mixed} [value] If passed, capability should somehow correlate to the value
    23352335                        @param {Object} [refCaps] Set of capabilities to check the specified cap against (defaults to internal set)
    2336                         @return {Boolean} true if runtime has such capability and false, if - not
     2336                        @return {boolean} true if runtime has such capability and false, if - not
    23372337                        */
    23382338                        can: function(cap, value) {
    23392339                                var refCaps = arguments[2] || caps;
     
    24842484        @method getRuntime
    24852485        @private
    24862486        @static
    2487         @param {String} uid Unique identifier of the runtime
    2488         @return {Runtime|Boolean} Returns runtime, if it exists and false, if - not
     2487        @param {string} uid Unique identifier of the runtime
     2488        @return {Runtime|boolean} Returns runtime, if it exists and false, if - not
    24892489        */
    24902490        Runtime.getRuntime = function(uid) {
    24912491                return runtimes[uid] ? runtimes[uid] : false;
     
    24972497
    24982498        @method addConstructor
    24992499        @static
    2500         @param {String} type Runtime type (e.g. flash, html5, etc)
     2500        @param {string} type Runtime type (e.g. flash, html5, etc)
    25012501        @param {Function} construct Constructor for the Runtime type
    25022502        */
    25032503        Runtime.addConstructor = function(type, constructor) {
     
    25112511
    25122512        method getConstructor
    25132513        @static
    2514         @param {String} type Runtime type (e.g. flash, html5, etc)
     2514        @param {string} type Runtime type (e.g. flash, html5, etc)
    25152515        @return {Function} Constructor for the Runtime type
    25162516        */
    25172517        Runtime.getConstructor = function(type) {
     
    25242524
    25252525        @method getInfo
    25262526        @static
    2527         @param {String} uid Unique identifier of the runtime
     2527        @param {string} uid Unique identifier of the runtime
    25282528        @return {Mixed} Info object or null if runtime doesn't exist
    25292529        */
    25302530        Runtime.getInfo = function(uid) {
     
    25492549
    25502550        @method parseCaps
    25512551        @static
    2552         @param {String} capStr Comma-separated list of capabilities
     2552        @param {string} capStr Comma-separated list of capabilities
    25532553        @return {Object}
    25542554        */
    25552555        Runtime.parseCaps = function(capStr) {
     
    25712571
    25722572        @method can
    25732573        @static
    2574         @param {String} type Runtime type (e.g. flash, html5, etc)
    2575         @param {String|Object} caps Set of capabilities to check
    2576         @return {Boolean} Result of the test
     2574        @param {string} type Runtime type (e.g. flash, html5, etc)
     2575        @param {string|Object} caps Set of capabilities to check
     2576        @return {boolean} Result of the test
    25772577        */
    25782578        Runtime.can = function(type, caps) {
    25792579                var runtime
     
    25972597
    25982598        @method thatCan
    25992599        @static
    2600         @param {String|Object} caps Set of capabilities to check
    2601         @param {String} [runtimeOrder] Comma-separated list of runtimes to check against
    2602         @return {String} Usable runtime identifier or null
     2600        @param {string|Object} caps Set of capabilities to check
     2601        @param {string} [runtimeOrder] Comma-separated list of runtimes to check against
     2602        @return {string} Usable runtime identifier or null
    26032603        */
    26042604        Runtime.thatCan = function(caps, runtimeOrder) {
    26052605                var types = (runtimeOrder || Runtime.order).split(/\s*,\s*/);
     
    26202620        @param {Object} modeCaps Set of capabilities that depend on particular runtime mode
    26212621        @param {Object} [requiredCaps] Supplied set of capabilities to find operational mode for
    26222622        @param {String|Boolean} [defaultMode='browser'] Default mode to use
    2623         @return {String|Boolean} Compatible operational mode
     2623        @return {string|boolean} Compatible operational mode
    26242624        */
    26252625        Runtime.getMode = function(modeCaps, requiredCaps, defaultMode) {
    26262626                var mode = null;
     
    31603160                        Disables file-picker element, so that it doesn't react to mouse clicks.
    31613161
    31623162                        @method disable
    3163                         @param {Boolean} [state=true] Disable component if - true, enable if - false
     3163                        @param {boolean} [state=true] Disable component if - true, enable if - false
    31643164                        */
    31653165                        disable: function(state) {
    31663166                                var runtime = this.getRuntime();
     
    32323232        @method utf8_encode
    32333233        @for Utils
    32343234        @static
    3235         @param {String} str String to encode
    3236         @return {String} UTF-8 encoded string
     3235        @param {string} str String to encode
     3236        @return {string} UTF-8 encoded string
    32373237        */
    32383238        var utf8_encode = function(str) {
    32393239                return unescape(encodeURIComponent(str));
     
    32443244
    32453245        @method utf8_decode
    32463246        @static
    3247         @param {String} str String to decode
    3248         @return {String} Decoded string
     3247        @param {string} str String to decode
     3248        @return {string} Decoded string
    32493249        */
    32503250        var utf8_decode = function(str_data) {
    32513251                return decodeURIComponent(escape(str_data));
     
    32573257
    32583258        @method atob
    32593259        @static
    3260         @param {String} data String to decode
    3261         @return {String} Decoded string
     3260        @param {string} data String to decode
     3261        @return {string} Decoded string
    32623262        */
    32633263        var atob = function(data, utf8) {
    32643264                if (typeof(window.atob) === 'function') {
     
    33263326
    33273327        @method btoa
    33283328        @static
    3329         @param {String} data String to encode
    3330         @return {String} Base64 encoded string
     3329        @param {string} data String to encode
     3330        @return {string} Base64 encoded string
    33313331        */
    33323332        var btoa = function(data, utf8) {
    33333333                if (utf8) {
     
    34153415        /**
    34163416        @class Blob
    34173417        @constructor
    3418         @param {String} ruid Unique id of the runtime, to which this blob belongs to
     3418        @param {string} ruid Unique id of the runtime, to which this blob belongs to
    34193419        @param {Object} blob Object "Native" blob object, as it is represented in the runtime
    34203420        */
    34213421        function Blob(ruid, blob) {
     
    34873487                       
    34883488                        /**
    34893489                        @method slice
    3490                         @param {Number} [start=0]
     3490                        @param {number} [start=0]
    34913491                        */
    34923492                        slice: function(start, end, type) {             
    34933493                                if (this.isDetached()) {
     
    35423542                       
    35433543                        @method isDetached
    35443544                        @protected
    3545                         @return {Boolean}
     3545                        @return {boolean}
    35463546                        */
    35473547                        isDetached: function() {
    35483548                                return !this.ruid && Basic.typeOf(blobpool[this.uid]) === 'string';
     
    35893589], function(Basic, Mime, Blob) {
    35903590        /**
    35913591        @class File
    3592         @extends Blob
     3592        @augments Blob
    35933593        @constructor
    3594         @param {String} ruid Unique id of the runtime, to which this blob belongs to
     3594        @param {string} ruid Unique id of the runtime, to which this blob belongs to
    35953595        @param {Object} file Object "Native" file object, as it is represented in the runtime
    35963596        */
    35973597        function File(ruid, file) {
     
    41264126        @method parseUrl
    41274127        @for Utils
    41284128        @static
    4129         @param {String} url Url to parse (defaults to empty string if undefined)
     4129        @param {string} url Url to parse (defaults to empty string if undefined)
    41304130        @return {Object} Hash containing extracted uri components
    41314131        */
    41324132        var parseUrl = function(url, currentUrl) {
     
    41934193
    41944194        @method resolveUrl
    41954195        @static
    4196         @param {String|Object} url Either absolute or relative, or a result of parseUrl call
    4197         @return {String} Resolved, absolute url
     4196        @param {string|Object} url Either absolute or relative, or a result of parseUrl call
     4197        @return {string} Resolved, absolute url
    41984198        */
    41994199        var resolveUrl = function(url) {
    42004200                var ports = { // we ignore default ports
     
    42114211        Check if specified url has the same origin as the current document
    42124212
    42134213        @method hasSameOrigin
    4214         @param {String|Object} url
    4215         @return {Boolean}
     4214        @param {string|Object} url
     4215        @return {boolean}
    42164216        */
    42174217        var hasSameOrigin = function(url) {
    42184218                function origin(url) {
     
    42574257        @class RuntimeTarget
    42584258        @constructor
    42594259        @protected
    4260         @extends EventTarget
     4260        @augments EventTarget
    42614261        */
    42624262        function RuntimeTarget() {
    42634263                this.uid = Basic.guid('uid_');
     
    43794379                        Append another key-value pair to the FormData object
    43804380
    43814381                        @method append
    4382                         @param {String} name Name for the new field
    4383                         @param {String|Blob|Array|Object} value Value for the field
     4382                        @param {string} name Name for the new field
     4383                        @param {string|Blob|Array|Object} value Value for the field
    43844384                        */
    43854385                        append: function(name, value) {
    43864386                                var self = this, valueType = Basic.typeOf(value);
     
    44154415                        Checks if FormData contains Blob.
    44164416
    44174417                        @method hasBlob
    4418                         @return {Boolean}
     4418                        @return {boolean}
    44194419                        */
    44204420                        hasBlob: function() {
    44214421                                return !!this.getBlob();
     
    44354435                        Retrieves blob field name.
    44364436
    44374437                        @method getBlobName
    4438                         @return {String} Either Blob field name or null
     4438                        @return {string} Either Blob field name or null
    44394439                        */
    44404440                        getBlobName: function() {
    44414441                                return _blob && _blob.name || null;
     
    47544754
    47554755
    47564756                        @method open
    4757                         @param {String} method HTTP method to use on request
    4758                         @param {String} url URL to request
    4759                         @param {Boolean} [async=true] If false request will be done in synchronous manner. Asynchronous by default.
    4760                         @param {String} [user] Username to use in HTTP authentication process on server-side
    4761                         @param {String} [password] Password to use in HTTP authentication process on server-side
     4757                        @param {string} method HTTP method to use on request
     4758                        @param {string} url URL to request
     4759                        @param {boolean} [async=true] If false request will be done in synchronous manner. Asynchronous by default.
     4760                        @param {string} [user] Username to use in HTTP authentication process on server-side
     4761                        @param {string} [password] Password to use in HTTP authentication process on server-side
    47624762                        */
    47634763                        open: function(method, url, async, user, password) {
    47644764                                var urlp;
     
    48364836                        is not a valid HTTP header field value.
    48374837                       
    48384838                        @method setRequestHeader
    4839                         @param {String} header
    4840                         @param {String|Number} value
     4839                        @param {string} header
     4840                        @param {string|number} value
    48414841                        */
    48424842                        setRequestHeader: function(header, value) {
    48434843                                var uaHeaders = [ // these headers are controlled by the user agent
     
    49044904                        Returns all headers from the response, with the exception of those whose field name is Set-Cookie or Set-Cookie2.
    49054905
    49064906                        @method getAllResponseHeaders
    4907                         @return {String} reponse headers or empty string
     4907                        @return {string} reponse headers or empty string
    49084908                        */
    49094909                        getAllResponseHeaders: function() {
    49104910                                return _responseHeaders || '';
     
    49154915                        unless the field name is Set-Cookie or Set-Cookie2.
    49164916
    49174917                        @method getResponseHeader
    4918                         @param {String} header
    4919                         @return {String} value(s) for the specified header or null
     4918                        @param {string} header
     4919                        @return {string} value(s) for the specified header or null
    49204920                        */
    49214921                        getResponseHeader: function(header) {
    49224922                                header = header.toLowerCase();
     
    57205720
    57215721                        @method clone
    57225722                        @param {Image} src Source for the image
    5723                         @param {Boolean} [exact=false] Whether to activate in-depth clone mode
     5723                        @param {boolean} [exact=false] Whether to activate in-depth clone mode
    57245724                        */
    57255725                        clone: function() {
    57265726                                this.load.apply(this, arguments);
     
    57505750                       
    57515751
    57525752                        @method load
    5753                         @param {Image|Blob|File|String} src Source for the image
     5753                        @param {Image|Blob|File|string} src Source for the image
    57545754                        @param {Boolean|Object} [mixed]
    57555755                        */
    57565756                        load: function() {
     
    57625762
    57635763                        @method downsize
    57645764                        @param {Object} opts
    5765                                 @param {Number} opts.width Resulting width
    5766                                 @param {Number} [opts.height=width] Resulting height (optional, if not supplied will default to width)
    5767                                 @param {Boolean} [opts.crop=false] Whether to crop the image to exact dimensions
    5768                                 @param {Boolean} [opts.preserveHeaders=true] Whether to preserve meta headers (on JPEGs after resize)
    5769                                 @param {String} [opts.resample=false] Resampling algorithm to use for resizing
     5765                                @param {number} opts.width Resulting width
     5766                                @param {number} [opts.height=width] Resulting height (optional, if not supplied will default to width)
     5767                                @param {boolean} [opts.crop=false] Whether to crop the image to exact dimensions
     5768                                @param {boolean} [opts.preserveHeaders=true] Whether to preserve meta headers (on JPEGs after resize)
     5769                                @param {string} [opts.resample=false] Resampling algorithm to use for resizing
    57705770                        */
    57715771                        downsize: function(opts) {
    57725772                                var defaults = {
     
    58125812                        Alias for downsize(width, height, true). (see downsize)
    58135813                       
    58145814                        @method crop
    5815                         @param {Number} width Resulting width
    5816                         @param {Number} [height=width] Resulting height (optional, if not supplied will default to width)
    5817                         @param {Boolean} [preserveHeaders=true] Whether to preserve meta headers (on JPEGs after resize)
     5815                        @param {number} width Resulting width
     5816                        @param {number} [height=width] Resulting height (optional, if not supplied will default to width)
     5817                        @param {boolean} [preserveHeaders=true] Whether to preserve meta headers (on JPEGs after resize)
    58185818                        */
    58195819                        crop: function(width, height, preserveHeaders) {
    58205820                                this.downsize(width, height, true, preserveHeaders);
     
    58345834                        DOMException.INVALID_STATE_ERR).
    58355835
    58365836                        @method getAsBlob
    5837                         @param {String} [type="image/jpeg"] Mime type of resulting blob. Can either be image/jpeg or image/png
    5838                         @param {Number} [quality=90] Applicable only together with mime type image/jpeg
     5837                        @param {string} [type="image/jpeg"] Mime type of resulting blob. Can either be image/jpeg or image/png
     5838                        @param {number} [quality=90] Applicable only together with mime type image/jpeg
    58395839                        @return {Blob} Image as Blob
    58405840                        */
    58415841                        getAsBlob: function(type, quality) {
     
    58505850                        DOMException.INVALID_STATE_ERR).
    58515851
    58525852                        @method getAsDataURL
    5853                         @param {String} [type="image/jpeg"] Mime type of resulting blob. Can either be image/jpeg or image/png
    5854                         @param {Number} [quality=90] Applicable only together with mime type image/jpeg
    5855                         @return {String} Image as dataURL string
     5853                        @param {string} [type="image/jpeg"] Mime type of resulting blob. Can either be image/jpeg or image/png
     5854                        @param {number} [quality=90] Applicable only together with mime type image/jpeg
     5855                        @return {string} Image as dataURL string
    58565856                        */
    58575857                        getAsDataURL: function(type, quality) {
    58585858                                if (!this.size) {
     
    58665866                        DOMException.INVALID_STATE_ERR).
    58675867
    58685868                        @method getAsBinaryString
    5869                         @param {String} [type="image/jpeg"] Mime type of resulting blob. Can either be image/jpeg or image/png
    5870                         @param {Number} [quality=90] Applicable only together with mime type image/jpeg
    5871                         @return {String} Image as binary string
     5869                        @param {string} [type="image/jpeg"] Mime type of resulting blob. Can either be image/jpeg or image/png
     5870                        @param {number} [quality=90] Applicable only together with mime type image/jpeg
     5871                        @return {string} Image as binary string
    58725872                        */
    58735873                        getAsBinaryString: function(type, quality) {
    58745874                                var dataUrl = this.getAsDataURL(type, quality);
     
    58835883                        @method embed
    58845884                        @param {DOMElement} el DOM element to insert the image object into
    58855885                        @param {Object} [opts]
    5886                                 @param {Number} [opts.width] The width of an embed (defaults to the image width)
    5887                                 @param {Number} [opts.height] The height of an embed (defaults to the image height)
    5888                                 @param {String} [type="image/jpeg"] Mime type
    5889                                 @param {Number} [quality=90] Quality of an embed, if mime type is image/jpeg
    5890                                 @param {Boolean} [crop=false] Whether to crop an embed to the specified dimensions
     5886                                @param {number} [opts.width] The width of an embed (defaults to the image width)
     5887                                @param {number} [opts.height] The height of an embed (defaults to the image height)
     5888                                @param {string} [type="image/jpeg"] Mime type
     5889                                @param {number} [quality=90] Quality of an embed, if mime type is image/jpeg
     5890                                @param {boolean} [crop=false] Whether to crop an embed to the specified dimensions
    58915891                        */
    58925892                        embed: function(el, opts) {
    58935893                                var self = this
     
    63336333        @for Utils
    63346334        @static
    63356335        @param {Object} obj DOM element like object to add handler to.
    6336         @param {String} name Name to add event listener to.
     6336        @param {string} name Name to add event listener to.
    63376337        @param {Function} callback Function to call when event occurs.
    6338         @param {String} [key] that might be used to add specifity to the event record.
     6338        @param {string} [key] that might be used to add specifity to the event record.
    63396339        */
    63406340        var addEvent = function(obj, name, callback, key) {
    63416341                var func, events;
     
    63946394        @method removeEvent
    63956395        @static
    63966396        @param {Object} obj DOM element to remove event listener(s) from.
    6397         @param {String} name Name of event listener to remove.
     6397        @param {string} name Name of event listener to remove.
    63986398        @param {Function|String} [callback] might be a callback or unique key to match.
    63996399        */
    64006400        var removeEvent = function(obj, name, callback) {
     
    64536453        @method removeAllEvents
    64546454        @static
    64556455        @param {Object} obj DOM element to remove event listeners from.
    6456         @param {String} [key] unique key to match, when removing events.
     6456        @param {string} [key] unique key to match, when removing events.
    64576457        */
    64586458        var removeAllEvents = function(obj, key) {             
    64596459                if (!obj || !obj[uid]) {
     
    85078507
    85088508        @class ImageInfo
    85098509        @constructor
    8510         @param {String} data Image source as binary string
     8510        @param {string} data Image source as binary string
    85118511        */
    85128512        return function(data) {
    85138513                var _cs = [JPEG, PNG], _img;
     
    85658565                        Sets Exif tag. Currently applicable only for width and height tags. Obviously works only with JPEGs.
    85668566
    85678567                        @method setExif
    8568                         @param {String} tag Tag to set
     8568                        @param {string} tag Tag to set
    85698569                        @param {Mixed} value Value to assign to the tag
    85708570                        */
    85718571                        setExif: function() {},
     
    85748574                        Restores headers to the source.
    85758575
    85768576                        @method writeHeaders
    8577                         @param {String} data Image source as binary string
    8578                         @return {String} Updated binary string
     8577                        @param {string} data Image source as binary string
     8578                        @return {string} Updated binary string
    85798579                        */
    85808580                        writeHeaders: function(data) {
    85818581                                return data;
     
    85858585                        Strip all headers from the source.
    85868586
    85878587                        @method stripHeaders
    8588                         @param {String} data Image source as binary string
    8589                         @return {String} Updated binary string
     8588                        @param {string} data Image source as binary string
     8589                        @return {string} Updated binary string
    85908590                        */
    85918591                        stripHeaders: function(data) {
    85928592                                return data;
  • src/js/_enqueues/vendor/plupload/plupload.js

     
    311311         * Get array of DOM Elements by their ids.
    312312         *
    313313         * @method get
    314          * @param {String} id Identifier of the DOM Element
     314         * @param {string} id Identifier of the DOM Element
    315315         * @return {Array}
    316316        */
    317317        getAll : function get(ids) {
     
    378378         *
    379379         * @method xmlEncode
    380380         * @static
    381          * @param {String} s String to encode.
    382          * @return {String} Encoded string.
     381         * @param {string} s String to encode.
     382         * @return {string} Encoded string.
    383383         */
    384384        xmlEncode : function(str) {
    385385                var xmlEncodeChars = {'<' : 'lt', '>' : 'gt', '&' : 'amp', '"' : 'quot', '\'' : '#39'}, xmlEncodeRegExp = /[<>&\"\']/g;
     
    520520         *
    521521         * @method cleanName
    522522         * @static
    523          * @param {String} s String to clean up.
    524          * @return {String} Cleaned string.
     523         * @param {string} s String to clean up.
     524         * @return {string} Cleaned string.
    525525         */
    526526        cleanName : function(name) {
    527527                var i, lookup;
     
    555555         *
    556556         * @method buildUrl
    557557         * @static
    558          * @param {String} url Base URL to append query string items to.
     558         * @param {string} url Base URL to append query string items to.
    559559         * @param {Object} items Name/value object to serialize as a querystring.
    560          * @return {String} String with url + serialized query string items.
     560         * @return {string} String with url + serialized query string items.
    561561         */
    562562        buildUrl : function(url, items) {
    563563                var query = '';
     
    578578         *
    579579         * @method formatSize
    580580         * @static
    581          * @param {Number} size Size to format as string.
    582          * @return {String} Formatted size string.
     581         * @param {number} size Size to format as string.
     582         * @return {string} Formatted size string.
    583583         */
    584584        formatSize : function(size) {
    585585
     
    634634         *
    635635         * @method predictRuntime
    636636         * @static
    637          * @param {Object|String} config Plupload settings to check
    638          * @param {String} [runtimes] Comma-separated list of runtimes to check against
    639          * @return {String} Type of compatible runtime
     637         * @param {Object|string} config Plupload settings to check
     638         * @param {string} [runtimes] Comma-separated list of runtimes to check against
     639         * @return {string} Type of compatible runtime
    640640         */
    641641        predictRuntime : function(config, runtimes) {
    642642                var up, runtime;
     
    656656         *
    657657         * @method addFileFilter
    658658         * @static
    659          * @param {String} name Name of the filter by which it can be referenced in settings.filters
    660          * @param {String} cb Callback - the actual routine that every added file must pass
     659         * @param {string} name Name of the filter by which it can be referenced in settings.filters
     660         * @param {string} cb Callback - the actual routine that every added file must pass
    661661         */
    662662        addFileFilter: function(name, cb) {
    663663                fileFilters[name] = cb;
     
    723723@constructor
    724724
    725725@param {Object} settings For detailed information about each option check documentation.
    726         @param {String|DOMElement} settings.browse_button id of the DOM element or DOM element itself to use as file dialog trigger.
    727         @param {String} settings.url URL of the server-side upload handler.
     726        @param {string|DOMElement} settings.browse_button id of the DOM element or DOM element itself to use as file dialog trigger.
     727        @param {string} settings.url URL of the server-side upload handler.
    728728        @param {Number|String} [settings.chunk_size=0] Chunk size in bytes to slice the file into. Shorcuts with b, kb, mb, gb, tb suffixes also supported. `e.g. 204800 or "204800b" or "200kb"`. By default - disabled.
    729         @param {Boolean} [settings.send_chunk_number=true] Whether to send chunks and chunk numbers, or total and offset bytes.
     729        @param {boolean} [settings.send_chunk_number=true] Whether to send chunks and chunk numbers, or total and offset bytes.
    730730        @param {String|DOMElement} [settings.container] id of the DOM element or DOM element itself that will be used to wrap uploader structures. Defaults to immediate parent of the `browse_button` element.
    731731        @param {String|DOMElement} [settings.drop_element] id of the DOM element or DOM element itself to use as a drop zone for Drag-n-Drop.
    732         @param {String} [settings.file_data_name="file"] Name for the file field in Multipart formated message.
     732        @param {string} [settings.file_data_name="file"] Name for the file field in Multipart formated message.
    733733        @param {Object} [settings.filters={}] Set of file type filters.
    734734                @param {Array} [settings.filters.mime_types=[]] List of file types to accept, each one defined by title and list of extensions. `e.g. {title : "Image files", extensions : "jpg,jpeg,gif,png"}`. Dispatches `plupload.FILE_EXTENSION_ERROR`
    735735                @param {String|Number} [settings.filters.max_file_size=0] Maximum file size that the user can pick, in bytes. Optionally supports b, kb, mb, gb, tb suffixes. `e.g. "10mb" or "1gb"`. By default - not set. Dispatches `plupload.FILE_SIZE_ERROR`.
    736                 @param {Boolean} [settings.filters.prevent_duplicates=false] Do not let duplicates into the queue. Dispatches `plupload.FILE_DUPLICATE_ERROR`.
    737         @param {String} [settings.flash_swf_url] URL of the Flash swf. (Not used in WordPress)
     736                @param {boolean} [settings.filters.prevent_duplicates=false] Do not let duplicates into the queue. Dispatches `plupload.FILE_DUPLICATE_ERROR`.
     737        @param {string} [settings.flash_swf_url] URL of the Flash swf. (Not used in WordPress)
    738738        @param {Object} [settings.headers] Custom headers to send with the upload. Hash of name/value pairs.
    739         @param {Number} [settings.max_retries=0] How many times to retry the chunk or file, before triggering Error event.
    740         @param {Boolean} [settings.multipart=true] Whether to send file and additional parameters as Multipart formated message.
     739        @param {number} [settings.max_retries=0] How many times to retry the chunk or file, before triggering Error event.
     740        @param {boolean} [settings.multipart=true] Whether to send file and additional parameters as Multipart formated message.
    741741        @param {Object} [settings.multipart_params] Hash of key/value pairs to send with every file upload.
    742         @param {Boolean} [settings.multi_selection=true] Enable ability to select multiple files at once in file dialog.
     742        @param {boolean} [settings.multi_selection=true] Enable ability to select multiple files at once in file dialog.
    743743        @param {String|Object} [settings.required_features] Either comma-separated list or hash of required features that chosen runtime should absolutely possess.
    744744        @param {Object} [settings.resize] Enable resizng of images on client-side. Applies to `image/jpeg` and `image/png` only. `e.g. {width : 200, height : 200, quality : 90, crop: true}`
    745                 @param {Number} [settings.resize.width] If image is bigger, it will be resized.
    746                 @param {Number} [settings.resize.height] If image is bigger, it will be resized.
    747                 @param {Number} [settings.resize.quality=90] Compression quality for jpegs (1-100).
    748                 @param {Boolean} [settings.resize.crop=false] Whether to crop images to exact dimensions. By default they will be resized proportionally.
    749         @param {String} [settings.runtimes="html5,html4"] Comma separated list of runtimes, that Plupload will try in turn, moving to the next if previous fails.
    750         @param {String} [settings.silverlight_xap_url] URL of the Silverlight xap. (Not used in WordPress)
    751         @param {Boolean} [settings.unique_names=false] If true will generate unique filenames for uploaded files.
    752         @param {Boolean} [settings.send_file_name=true] Whether to send file name as additional argument - 'name' (required for chunked uploads and some other cases where file name cannot be sent via normal ways).
     745                @param {number} [settings.resize.width] If image is bigger, it will be resized.
     746                @param {number} [settings.resize.height] If image is bigger, it will be resized.
     747                @param {number} [settings.resize.quality=90] Compression quality for jpegs (1-100).
     748                @param {boolean} [settings.resize.crop=false] Whether to crop images to exact dimensions. By default they will be resized proportionally.
     749        @param {string} [settings.runtimes="html5,html4"] Comma separated list of runtimes, that Plupload will try in turn, moving to the next if previous fails.
     750        @param {string} [settings.silverlight_xap_url] URL of the Silverlight xap. (Not used in WordPress)
     751        @param {boolean} [settings.unique_names=false] If true will generate unique filenames for uploaded files.
     752        @param {boolean} [settings.send_file_name=true] Whether to send file name as additional argument - 'name' (required for chunked uploads and some other cases where file name cannot be sent via normal ways).
    753753*/
    754754plupload.Uploader = function(options) {
    755755        /**
     
    18151815                 *
    18161816                 * @method setOption
    18171817                 * @since 2.1
    1818                  * @param {String|Object} option Name of the option to change or the set of key/value pairs
     1818                 * @param {string|Object} option Name of the option to change or the set of key/value pairs
    18191819                 * @param {Mixed} [value] Value for the option (is ignored, if first argument is object)
    18201820                 */
    18211821                setOption: function(option, value) {
     
    18271827                 *
    18281828                 * @method getOption
    18291829                 * @since 2.1
    1830                  * @param {String} [option] Name of the option to get
     1830                 * @param {string} [option] Name of the option to get
    18311831                 * @return {Mixed} Value for the option or the whole set
    18321832                 */
    18331833                getOption: function(option) {
     
    18841884                 * Disables/enables browse button on request.
    18851885                 *
    18861886                 * @method disableBrowse
    1887                  * @param {Boolean} disable Whether to disable or enable (default: true)
     1887                 * @param {boolean} disable Whether to disable or enable (default: true)
    18881888                 */
    18891889                disableBrowse : function() {
    18901890                        disabled = arguments[0] !== undef ? arguments[0] : true;
     
    19021902                 * Returns the specified file object by id.
    19031903                 *
    19041904                 * @method getFile
    1905                  * @param {String} id File id to look for.
     1905                 * @param {string} id File id to look for.
    19061906                 * @return {plupload.File} File object or undefined if it wasn't found;
    19071907                 */
    19081908                getFile : function(id) {
     
    19221922                 * @method addFile
    19231923                 * @since 2.0
    19241924                 * @param {plupload.File|mOxie.File|File|Node|Array} file File or files to add to the queue.
    1925                  * @param {String} [fileName] If specified, will be used as a name for the file
     1925                 * @param {string} [fileName] If specified, will be used as a name for the file
    19261926                 */
    19271927                addFile : function(file, fileName) {
    19281928                        var self = this
     
    20242024                 * Removes a specific file.
    20252025                 *
    20262026                 * @method removeFile
    2027                  * @param {plupload.File|String} file File to remove from queue.
     2027                 * @param {plupload.File|string} file File to remove from queue.
    20282028                 */
    20292029                removeFile : function(file) {
    20302030                        var id = typeof(file) === 'string' ? file : file.id;
     
    20402040                 * Removes part of the queue and returns the files removed. This will also trigger the FilesRemoved and QueueChanged events.
    20412041                 *
    20422042                 * @method splice
    2043                  * @param {Number} start (Optional) Start index to remove from.
    2044                  * @param {Number} length (Optional) Lengh of items to remove.
     2043                 * @param {number} start (Optional) Start index to remove from.
     2044                 * @param {number} length (Optional) Lengh of items to remove.
    20452045                 * @return {Array} Array of files that was removed.
    20462046                 */
    20472047                splice : function(start, length) {
     
    21242124                Adds an event listener by name.
    21252125
    21262126                @method bind
    2127                 @param {String} name Event name to listen for.
     2127                @param {string} name Event name to listen for.
    21282128                @param {function} fn Function to call ones the event gets fired.
    21292129                @param {Object} [scope] Optional scope to execute the specified function in.
    2130                 @param {Number} [priority=0] Priority of the event handler - handlers with higher priorities will be called first
     2130                @param {number} [priority=0] Priority of the event handler - handlers with higher priorities will be called first
    21312131                */
    21322132                bind: function(name, fn, scope, priority) {
    21332133                        // adapt moxie EventTarget style to Plupload-like
  • src/js/_enqueues/vendor/plupload/wp-plupload.js

     
    2323         * @memberOf wp
    2424         * @alias wp.Uploader
    2525         *
    26          * @param {object} options           The options passed to the new plupload instance.
    27          * @param {object} options.container The id of uploader container.
    28          * @param {object} options.browser   The id of button to trigger the file select.
    29          * @param {object} options.dropzone  The id of file drop target.
    30          * @param {object} options.plupload  An object of parameters to pass to the plupload instance.
    31          * @param {object} options.params    An object of parameters to pass to $_POST when uploading the file.
     26         * @param {Object} options           The options passed to the new plupload instance.
     27         * @param {Object} options.container The id of uploader container.
     28         * @param {Object} options.browser   The id of button to trigger the file select.
     29         * @param {Object} options.dropzone  The id of file drop target.
     30         * @param {Object} options.plupload  An object of parameters to pass to the plupload instance.
     31         * @param {Object} options.params    An object of parameters to pass to $_POST when uploading the file.
    3232         *                                   Extends this.plupload.multipart_params under the hood.
    3333         */
    3434        Uploader = function( options ) {
     
    116116                 * @since 5.3.0
    117117                 *
    118118                 * @param {string}        message Error message.
    119                  * @param {object}        data    Error data from Plupload.
     119                 * @param {Object}        data    Error data from Plupload.
    120120                 * @param {plupload.File} file    File that was uploaded.
    121121                 */
    122122                tryAgain = function( message, data, file ) {
     
    204204                 * and display errors. @see wp.Uploader.errors.
    205205                 *
    206206                 * @param {string}        message Error message.
    207                  * @param {object}        data    Error data from Plupload.
     207                 * @param {Object}        data    Error data from Plupload.
    208208                 * @param {plupload.File} file    File that was uploaded.
    209209                 * @param {string}        retry   Whether to try again to create image sub-sizes. Passing 'no-retry' will prevent it.
    210210                 */
  • src/js/_enqueues/vendor/tinymce/plugins/wptextpattern/plugin.js

     
    5252        /**
    5353         * Escapes characters for use in a Regular Expression.
    5454         *
    55          * @param {String} string Characters to escape
     55         * @param {string} string Characters to escape
    5656         *
    57          * @return {String} Escaped characters
     57         * @return {string} Escaped characters
    5858         */
    5959        function escapeRegExp( string ) {
    6060                return string.replace( /[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, '\\$&' );
  • src/js/_enqueues/vendor/tinymce/tiny_mce_popup.js

     
    107107   * Returns a window argument/parameter by name.
    108108   *
    109109   * @method getWindowArg
    110    * @param {String} name Name of the window argument to retrieve.
    111    * @param {String} defaultValue Optional default value to return.
    112    * @return {String} Argument value or default value if it wasn't found.
     110   * @param {string} name Name of the window argument to retrieve.
     111   * @param {string} defaultValue Optional default value to return.
     112   * @return {string} Argument value or default value if it wasn't found.
    113113   */
    114114  getWindowArg: function (name, defaultValue) {
    115115    var value = this.params[name];
     
    121121   * Returns a editor parameter/config option value.
    122122   *
    123123   * @method getParam
    124    * @param {String} name Name of the editor config option to retrieve.
    125    * @param {String} defaultValue Optional default value to return.
    126    * @return {String} Parameter value or default value if it wasn't found.
     124   * @param {string} name Name of the editor config option to retrieve.
     125   * @param {string} defaultValue Optional default value to return.
     126   * @return {string} Parameter value or default value if it wasn't found.
    127127   */
    128128  getParam: function (name, defaultValue) {
    129129    return this.editor.getParam(name, defaultValue);
     
    133133   * Returns a language item by key.
    134134   *
    135135   * @method getLang
    136    * @param {String} name Language item like mydialog.something.
    137    * @param {String} defaultValue Optional default value to return.
    138    * @return {String} Language value for the item like "my string" or the default value if it wasn't found.
     136   * @param {string} name Language item like mydialog.something.
     137   * @param {string} defaultValue Optional default value to return.
     138   * @return {string} Language value for the item like "my string" or the default value if it wasn't found.
    139139   */
    140140  getLang: function (name, defaultValue) {
    141141    return this.editor.getLang(name, defaultValue);
     
    145145   * Executed a command on editor that opened the dialog/popup.
    146146   *
    147147   * @method execCommand
    148    * @param {String} cmd Command to execute.
    149    * @param {Boolean} ui Optional boolean value if the UI for the command should be presented or not.
     148   * @param {string} cmd Command to execute.
     149   * @param {boolean} ui Optional boolean value if the UI for the command should be presented or not.
    150150   * @param {Object} val Optional value to pass with the comman like an URL.
    151151   * @param {Object} a Optional arguments object.
    152152   */
     
    185185   * was added for compatibility with the 2.x branch.
    186186   *
    187187   * @method executeOnLoad
    188    * @param {String} evil String to evalutate on init.
     188   * @param {string} evil String to evalutate on init.
    189189   */
    190190  executeOnLoad: function (evil) {
    191191    this.onInit.add(function () {
     
    285285   * native version use the callback method instead then it can be extended.
    286286   *
    287287   * @method confirm
    288    * @param {String} t Title for the new confirm dialog.
     288   * @param {string} t Title for the new confirm dialog.
    289289   * @param {function} cb Callback function to be executed after the user has selected ok or cancel.
    290290   * @param {Object} s Optional scope to execute the callback in.
    291291   */
     
    298298   * native version use the callback method instead then it can be extended.
    299299   *
    300300   * @method alert
    301    * @param {String} tx Title for the new alert dialog.
     301   * @param {string} tx Title for the new alert dialog.
    302302   * @param {function} cb Callback function to be executed after the user has selected ok.
    303303   * @param {Object} s Optional scope to execute the callback in.
    304304   */
  • src/js/_enqueues/wp/a11y.js

     
    1818         * @since 4.2.0
    1919         * @since 4.3.0 Introduced the 'ariaLive' argument.
    2020         *
    21          * @param {String} message    The message to be announced by Assistive Technologies.
    22          * @param {String} [ariaLive] The politeness level for aria-live. Possible values:
     21         * @param {string} message    The message to be announced by Assistive Technologies.
     22         * @param {string} [ariaLive] The politeness level for aria-live. Possible values:
    2323         *                            polite or assertive. Default polite.
    2424         * @return {void}
    2525         */
     
    5353         *
    5454         * @since 4.3.0
    5555         *
    56          * @param {String} ariaLive Optional. Value for the 'aria-live' attribute, default 'polite'.
     56         * @param {string} ariaLive Optional. Value for the 'aria-live' attribute, default 'polite'.
    5757         *
    5858         * @return {Object} $container The ARIA live region jQuery object.
    5959         */
  • src/js/_enqueues/wp/api.js

     
    186186         * Extract a route part based on negative index.
    187187         *
    188188         * @param {string}   route          The endpoint route.
    189          * @param {int}      part           The number of parts from the end of the route to retrieve. Default 1.
     189         * @param {number}      part           The number of parts from the end of the route to retrieve. Default 1.
    190190         *                                  Example route `/a/b/c`: part 1 is `c`, part 2 is `b`, part 3 is `a`.
    191191         * @param {string}  [versionString] Version string, defaults to `wp.api.versionString`.
    192192         * @param {boolean} [reverse]       Whether to reverse the order when extracting the route part. Optional, default false.
     
    234234        /**
    235235         * Add args and options to a model prototype from a route's endpoints.
    236236         *
    237          * @param {array}  routeEndpoints Array of route endpoints.
     237         * @param {Array}  routeEndpoints Array of route endpoints.
    238238         * @param {Object} modelInstance  An instance of the model (or collection)
    239239         *                                to add the args to.
    240240         */
     
    361361                         * Build a helper function to retrieve related model.
    362362                         *
    363363                         * @param {string} parentModel      The parent model.
    364                          * @param {int}    modelId          The model ID if the object to request
     364                         * @param {number}    modelId          The model ID if the object to request
    365365                         * @param {string} modelName        The model name to use when constructing the model.
    366366                         * @param {string} embedSourcePoint Where to check the embedds object for _embed data.
    367367                         * @param {string} embedCheckField  Which model field to check to see if the model has data.
     
    513513                                 *
    514514                                 * @param {string} key The meta key.
    515515                                 *
    516                                  * @return {object} The post meta value.
     516                                 * @return {Object} The post meta value.
    517517                                 */
    518518                                getMeta: function( key ) {
    519519                                        var metas = this.get( 'meta' );
     
    523523                                /**
    524524                                 * Get all meta key/values for a post.
    525525                                 *
    526                                  * @return {object} The post metas, as a key value pair object.
     526                                 * @return {Object} The post metas, as a key value pair object.
    527527                                 */
    528528                                getMetas: function() {
    529529                                        return this.get( 'meta' );
     
    532532                                /**
    533533                                 * Set a group of meta key/values for a post.
    534534                                 *
    535                                  * @param {object} meta The post meta to set, as key/value pairs.
     535                                 * @param {Object} meta The post meta to set, as key/value pairs.
    536536                                 */
    537537                                setMetas: function( meta ) {
    538538                                        var metas = this.get( 'meta' );
     
    544544                                 * Set a single meta value for a post, by key.
    545545                                 *
    546546                                 * @param {string} key   The meta key.
    547                                  * @param {object} value The meta value.
     547                                 * @param {Object} value The meta value.
    548548                                 */
    549549                                setMeta: function( key, value ) {
    550550                                        var metas = this.get( 'meta' );
     
    589589                                 *
    590590                                 * Accepts an array of tag slugs, or a Tags collection.
    591591                                 *
    592                                  * @param {array|Backbone.Collection} tags The tags to set on the post.
     592                                 * @param {Array|Backbone.Collection} tags The tags to set on the post.
    593593                                 *
    594594                                 */
    595595                                setTags: function( tags ) {
     
    635635                                 *
    636636                                 * Accepts a Tags collection.
    637637                                 *
    638                                  * @param {array|Backbone.Collection} tags The tags to set on the post.
     638                                 * @param {Array|Backbone.Collection} tags The tags to set on the post.
    639639                                 *
    640640                                 */
    641641                                setTagsWithCollection: function( tags ) {
     
    673673                                 *
    674674                                 * Accepts an array of category slugs, or a Categories collection.
    675675                                 *
    676                                  * @param {array|Backbone.Collection} categories The categories to set on the post.
     676                                 * @param {Array|Backbone.Collection} categories The categories to set on the post.
    677677                                 *
    678678                                 */
    679679                                setCategories: function( categories ) {
     
    720720                                 *
    721721                                 * Accepts Categories collection.
    722722                                 *
    723                                  * @param {array|Backbone.Collection} categories The categories to set on the post.
     723                                 * @param {Array|Backbone.Collection} categories The categories to set on the post.
    724724                                 *
    725725                                 */
    726726                                setCategoriesWithCollection: function( categories ) {
     
    14951495        /**
    14961496         * Initialize the wp-api, optionally passing the API root.
    14971497         *
    1498          * @param {object} [args]
     1498         * @param {Object} [args]
    14991499         * @param {string} [args.nonce] The nonce. Optional, defaults to wpApiSettings.nonce.
    15001500         * @param {string} [args.apiRoot] The api root. Optional, defaults to wpApiSettings.root.
    15011501         * @param {string} [args.versionString] The version string. Optional, defaults to wpApiSettings.root.
    1502          * @param {object} [args.schema] The schema. Optional, will be fetched from API if not provided.
     1502         * @param {Object} [args.schema] The schema. Optional, will be fetched from API if not provided.
    15031503         */
    15041504        wp.api.init = function( args ) {
    15051505                var endpoint, attributes = {}, deferred, promise;
  • src/js/_enqueues/wp/code-editor.js

     
    3939         * Configure linting.
    4040         *
    4141         * @param {CodeMirror} editor - Editor.
    42          * @param {object}     settings - Code editor settings.
    43          * @param {object}     settings.codeMirror - Settings for CodeMirror.
     42         * @param {Object}     settings - Code editor settings.
     43         * @param {Object}     settings.codeMirror - Settings for CodeMirror.
    4444         * @param {Function}   settings.onChangeLintingErrors - Callback for when there are changes to linting errors.
    4545         * @param {Function}   settings.onUpdateErrorNotice - Callback to update error notice.
    4646         *
     
    6464                /**
    6565                 * Get lint options.
    6666                 *
    67                  * @return {object} Lint options.
     67                 * @return {Object} Lint options.
    6868                 */
    6969                function getLintOptions() { // eslint-disable-line complexity
    7070                        var options = editor.getOption( 'lint' );
     
    213213         * Configure tabbing.
    214214         *
    215215         * @param {CodeMirror} codemirror - Editor.
    216          * @param {object}     settings - Code editor settings.
    217          * @param {object}     settings.codeMirror - Settings for CodeMirror.
     216         * @param {Object}     settings - Code editor settings.
     217         * @param {Object}     settings.codeMirror - Settings for CodeMirror.
    218218         * @param {Function}   settings.onTabNext - Callback to handle tabbing to the next tabbable element.
    219219         * @param {Function}   settings.onTabPrevious - Callback to handle tabbing to the previous tabbable element.
    220220         *
     
    267267         * @since 4.9.0
    268268         *
    269269         * @param {string|jQuery|Element} textarea - The HTML id, jQuery object, or DOM Element for the textarea that is used for the editor.
    270          * @param {object}                [settings] - Settings to override defaults.
     270         * @param {Object}                [settings] - Settings to override defaults.
    271271         * @param {Function}              [settings.onChangeLintingErrors] - Callback for when the linting errors have changed.
    272272         * @param {Function}              [settings.onUpdateErrorNotice] - Callback for when error notice should be displayed.
    273273         * @param {Function}              [settings.onTabPrevious] - Callback to handle tabbing to the previous tabbable element.
    274274         * @param {Function}              [settings.onTabNext] - Callback to handle tabbing to the next tabbable element.
    275          * @param {object}                [settings.codemirror] - Options for CodeMirror.
    276          * @param {object}                [settings.csslint] - Rules for CSSLint.
    277          * @param {object}                [settings.htmlhint] - Rules for HTMLHint.
    278          * @param {object}                [settings.jshint] - Rules for JSHint.
     275         * @param {Object}                [settings.codemirror] - Options for CodeMirror.
     276         * @param {Object}                [settings.csslint] - Rules for CSSLint.
     277         * @param {Object}                [settings.htmlhint] - Rules for HTMLHint.
     278         * @param {Object}                [settings.jshint] - Rules for JSHint.
    279279         *
    280280         * @return {CodeEditorInstance} Instance.
    281281         */
  • src/js/_enqueues/wp/custom-header.js

     
    108108                /**
    109109                 * Initialize the video handler.
    110110                 *
    111                  * @param {object} settings Video settings.
     111                 * @param {Object} settings Video settings.
    112112                 */
    113113                initialize: function( settings ) {
    114114                        var handler = this,
     
    217217                 * Whether the handler can process a video.
    218218                 *
    219219                 * @abstract
    220                  * @param {object} settings Video settings.
     220                 * @param {Object} settings Video settings.
    221221                 * @return {boolean}
    222222                 */
    223223                test: function() {
     
    239239         *
    240240         * @memberOf wp
    241241         *
    242          * @param {object} protoProps Properties to apply to the prototype.
     242         * @param {Object} protoProps Properties to apply to the prototype.
    243243         * @return CustomHandler The subclass.
    244244         */
    245245        BaseHandler.extend = function( protoProps ) {
     
    271271                /**
    272272                 * Whether the native handler supports a video.
    273273                 *
    274                  * @param {object} settings Video settings.
     274                 * @param {Object} settings Video settings.
    275275                 * @return {boolean}
    276276                 */
    277277                test: function( settings ) {
     
    345345                /**
    346346                 * Whether the handler supports a video.
    347347                 *
    348                  * @param {object} settings Video settings.
     348                 * @param {Object} settings Video settings.
    349349                 * @return {boolean}
    350350                 */
    351351                test: function( settings ) {
  • src/js/_enqueues/wp/customize/base.js

     
    188188        api.Value = api.Class.extend(/** @lends wp.customize.Value.prototype */{
    189189                /**
    190190                 * @param {mixed}  initial The initial value.
    191                  * @param {object} options
     191                 * @param {Object} options
    192192                 */
    193193                initialize: function( initial, options ) {
    194194                        this._value = initial; // @todo Potentially change this to a this.set() call.
     
    220220                /**
    221221                 * Set the value and trigger all bound callbacks.
    222222                 *
    223                  * @param {object} to New value.
     223                 * @param {Object} to New value.
    224224                 */
    225225                set: function( to ) {
    226226                        var from = this._value;
     
    382382                 * Whether the collection has an item with the given ID.
    383383                 *
    384384                 * @param {string} id The ID of the item to look for.
    385                  * @return {Boolean}
     385                 * @return {boolean}
    386386                 */
    387387                has: function( id ) {
    388388                        return typeof this._value[ id ] !== 'undefined';
     
    447447                 * Iterate over all items in the collection invoking the provided callback.
    448448                 *
    449449                 * @param {Function} callback Function to invoke.
    450                  * @param {object}   context  Object context to invoke the function with. Optional.
     450                 * @param {Object}   context  Object context to invoke the function with. Optional.
    451451                 */
    452452                each: function( callback, context ) {
    453453                        context = typeof context === 'undefined' ? this : context;
     
    682682                /**
    683683                 * Initialize Messenger.
    684684                 *
    685                  * @param {object} params  - Parameters to configure the messenger.
     685                 * @param {Object} params  - Parameters to configure the messenger.
    686686                 *        {string} params.url          - The URL to communicate with.
    687687                 *        {window} params.targetWindow - The window instance to communicate with. Default window.parent.
    688688                 *        {string} params.channel      - If provided, will send the channel with each message and only accept messages a matching channel.
    689                  * @param {object} options - Extend any instance parameter or method with this object.
     689                 * @param {Object} options - Extend any instance parameter or method with this object.
    690690                 */
    691691                initialize: function( params, options ) {
    692692                        // Target the parent frame by default, but only if a parent frame exists.
     
    787787                 * Send data to the other window.
    788788                 *
    789789                 * @param {string} id   The event name.
    790                  * @param {object} data Data.
     790                 * @param {Object} data Data.
    791791                 */
    792792                send: function( id, data ) {
    793793                        var message;
     
    862862                 * @since 4.9.0
    863863                 *
    864864                 * @param {string}   code - Notification code.
    865                  * @param {object}   params - Notification parameters.
     865                 * @param {Object}   params - Notification parameters.
    866866                 * @param {string}   params.message - Message.
    867867                 * @param {string}   [params.type=error] - Type.
    868868                 * @param {string}   [params.setting] - Related setting ID.
     
    934934         *
    935935         * @alias wp.customize.get
    936936         *
    937          * @return {object}
     937         * @return {Object}
    938938         */
    939939        api.get = function() {
    940940                var result = {};
     
    962962         * @alias wp.customize.utils.parseQueryString
    963963         *
    964964         * @param {string} queryString Query string.
    965          * @return {object} Parsed query string.
     965         * @return {Object} Parsed query string.
    966966         */
    967967        api.utils.parseQueryString = function parseQueryString( queryString ) {
    968968                var queryParams = {};
  • src/js/_enqueues/wp/customize/controls.js

     
    2525                 * @since 4.9.0
    2626                 *
    2727                 * @param {string} code - Code.
    28                  * @param {object} params - Params.
     28                 * @param {Object} params - Params.
    2929                 */
    3030                initialize: function( code, params ) {
    3131                        var notification = this;
     
    9494                 * @constructs wp.customize.Notifications
    9595                 * @augments   wp.customize.Values
    9696                 *
    97                  * @param {object}  options - Options.
     97                 * @param {Object}  options - Options.
    9898                 * @param {jQuery}  [options.container] - Container element for notifications. This can be injected later.
    9999                 * @param {boolean} [options.alt] - Whether alternative style should be used when rendering notifications.
    100100                 *
     
    174174                 * Notifications may be sorted by type followed by added time.
    175175                 *
    176176                 * @since 4.9.0
    177                  * @param {object}  args - Args.
     177                 * @param {Object}  args - Args.
    178178                 * @param {boolean} [args.sort=false] - Whether to return the notifications sorted.
    179179                 * @return {Array.<wp.customize.Notification>} Notifications.
    180180                 */
     
    362362                 *
    363363                 * @param {string}  id                          - The setting ID.
    364364                 * @param {*}       value                       - The initial value of the setting.
    365                  * @param {object}  [options={}]                - Options.
     365                 * @param {Object}  [options={}]                - Options.
    366366                 * @param {string}  [options.transport=refresh] - The transport to use for previewing. Supports 'refresh' and 'postMessage'.
    367367                 * @param {boolean} [options.dirty=false]       - Whether the setting should be considered initially dirty.
    368                  * @param {object}  [options.previewer]         - The Previewer instance to sync with. Defaults to wp.customize.previewer.
     368                 * @param {Object}  [options.previewer]         - The Previewer instance to sync with. Defaults to wp.customize.previewer.
    369369                 */
    370370                initialize: function( id, value, options ) {
    371371                        var setting = this, params;
     
    495495         * @since 4.7.0
    496496         * @access public
    497497         *
    498          * @param {object} [options] Options.
     498         * @param {Object} [options] Options.
    499499         * @param {boolean} [options.unsaved=false] Whether only values not saved yet into a changeset will be returned (differential changes).
    500          * @return {object} Dirty setting values.
     500         * @return {Object} Dirty setting values.
    501501         */
    502502        api.dirtyValues = function dirtyValues( options ) {
    503503                var values = {};
     
    528528         * @since 4.7.0
    529529         * @access public
    530530         *
    531          * @param {object}  [changes] - Mapping of setting IDs to setting params each normally including a value property, or mapping to null.
     531         * @param {Object}  [changes] - Mapping of setting IDs to setting params each normally including a value property, or mapping to null.
    532532         *                             If not provided, then the changes will still be obtained from unsaved dirty settings.
    533          * @param {object}  [args] - Additional options for the save request.
     533         * @param {Object}  [args] - Additional options for the save request.
    534534         * @param {boolean} [args.autosave=false] - Whether changes will be stored in autosave revision if the changeset has been promoted from an auto-draft.
    535535         * @param {boolean} [args.force=false] - Send request to update even when there are no changes to submit. This can be used to request the latest status of the changeset on the server.
    536536         * @param {string}  [args.title] - Title to update in the changeset. Optional.
     
    736736         *
    737737         * @param {(wp.customize.Panel|wp.customize.Section|wp.customize.Control)} a
    738738         * @param {(wp.customize.Panel|wp.customize.Section|wp.customize.Control)} b
    739          * @return {Number}
     739         * @return {number}
    740740         */
    741741        api.utils.prioritySort = function ( a, b ) {
    742742                if ( a.priority() === b.priority() && typeof a.params.instanceNumber === 'number' && typeof b.params.instanceNumber === 'number' ) {
     
    796796         * @since 4.9.0
    797797         *
    798798         * @param {jQuery} button - The element to highlight.
    799          * @param {object} [options] - Options.
     799         * @param {Object} [options] - Options.
    800800         * @param {number} [options.delay=0] - Delay in milliseconds.
    801801         * @param {jQuery} [options.focusTarget] - A target for user focus that defaults to the highlighted element.
    802802         *                                         If the user focuses the target before the delay passes, the reminder
     
    850850         *
    851851         * @since 4.9.0
    852852         *
    853          * @return {int} Current timestamp.
     853         * @return {number} Current timestamp.
    854854         */
    855855        api.utils.getCurrentTimestamp = function getCurrentTimestamp() {
    856856                var currentDate, currentClientTimestamp, timestampDifferential;
     
    869869         *
    870870         * @since 4.9.0
    871871         *
    872          * @param {string|int|Date} datetime - Date time or timestamp of the future date.
    873          * @return {int} remainingTime - Remaining time in milliseconds.
     872         * @param {string|number|Date} datetime - Date time or timestamp of the future date.
     873         * @return {number} remainingTime - Remaining time in milliseconds.
    874874         */
    875875        api.utils.getRemainingTime = function getRemainingTime( datetime ) {
    876876                var millisecondsDivider = 1000, remainingTime, timestamp;
     
    940940                 * @borrows wp.customize~focus as focus
    941941                 *
    942942                 * @param {string}  id - The ID for the container.
    943                  * @param {object}  options - Object containing one property: params.
     943                 * @param {Object}  options - Object containing one property: params.
    944944                 * @param {string}  options.title - Title shown when panel is collapsed and expanded.
    945945                 * @param {string}  [options.description] - Description shown at the top of the panel.
    946946                 * @param {number}  [options.priority=100] - The sort priority for the panel.
     
    948948                 * @param {string}  [options.type=default] - The type of the panel. See wp.customize.panelConstructor.
    949949                 * @param {string}  [options.content] - The markup to be used for the panel container. If empty, a JS template is used.
    950950                 * @param {boolean} [options.active=true] - Whether the panel is active or not.
    951                  * @param {object}  [options.params] - Deprecated wrapper for the above properties.
     951                 * @param {Object}  [options.params] - Deprecated wrapper for the above properties.
    952952                 */
    953953                initialize: function ( id, options ) {
    954954                        var container = this;
     
    10551055                 *
    10561056                 * @since 4.1.0
    10571057                 *
    1058                  * @param {String} parentType
    1059                  * @param {String} childType
     1058                 * @param {string} parentType
     1059                 * @param {string} childType
    10601060                 * @return {Array}
    10611061                 */
    10621062                _children: function ( parentType, childType ) {
     
    11541154                /**
    11551155                 * @since 4.1.0
    11561156                 *
    1157                  * @param {Boolean} active
     1157                 * @param {boolean} active
    11581158                 * @param {Object}  [params]
    1159                  * @return {Boolean} False if state already applied.
     1159                 * @return {boolean} False if state already applied.
    11601160                 */
    11611161                _toggleActive: function ( active, params ) {
    11621162                        var self = this;
     
    11751175
    11761176                /**
    11771177                 * @param {Object} [params]
    1178                  * @return {Boolean} False if already active.
     1178                 * @return {boolean} False if already active.
    11791179                 */
    11801180                activate: function ( params ) {
    11811181                        return this._toggleActive( true, params );
     
    11831183
    11841184                /**
    11851185                 * @param {Object} [params]
    1186                  * @return {Boolean} False if already inactive.
     1186                 * @return {boolean} False if already inactive.
    11871187                 */
    11881188                deactivate: function ( params ) {
    11891189                        return this._toggleActive( false, params );
     
    12001200                /**
    12011201                 * Handle the toggle logic for expand/collapse.
    12021202                 *
    1203                  * @param {Boolean}  expanded - The new state to apply.
     1203                 * @param {boolean}  expanded - The new state to apply.
    12041204                 * @param {Object}   [params] - Object containing options for expand/collapse.
    12051205                 * @param {Function} [params.completeCallback] - Function to call when expansion/collapse is complete.
    1206                  * @return {Boolean} False if state already applied or active state is false.
     1206                 * @return {boolean} False if state already applied or active state is false.
    12071207                 */
    12081208                _toggleExpanded: function( expanded, params ) {
    12091209                        var instance = this, previousCompleteCallback;
     
    12401240
    12411241                /**
    12421242                 * @param {Object} [params]
    1243                  * @return {Boolean} False if already expanded or if inactive.
     1243                 * @return {boolean} False if already expanded or if inactive.
    12441244                 */
    12451245                expand: function ( params ) {
    12461246                        return this._toggleExpanded( true, params );
     
    12481248
    12491249                /**
    12501250                 * @param {Object} [params]
    1251                  * @return {Boolean} False if already collapsed.
     1251                 * @return {boolean} False if already collapsed.
    12521252                 */
    12531253                collapse: function ( params ) {
    12541254                        return this._toggleExpanded( false, params );
     
    14091409                 * @since 4.1.0
    14101410                 *
    14111411                 * @param {string}  id - The ID for the section.
    1412                  * @param {object}  options - Options.
     1412                 * @param {Object}  options - Options.
    14131413                 * @param {string}  options.title - Title shown when section is collapsed and expanded.
    14141414                 * @param {string}  [options.description] - Description shown at the top of the section.
    14151415                 * @param {number}  [options.priority=100] - The sort priority for the section.
     
    14181418                 * @param {boolean} [options.active=true] - Whether the section is active or not.
    14191419                 * @param {string}  options.panel - The ID for the panel this section is associated with.
    14201420                 * @param {string}  [options.customizeAction] - Additional context information shown before the section title when expanded.
    1421                  * @param {object}  [options.params] - Deprecated wrapper for the above properties.
     1421                 * @param {Object}  [options.params] - Deprecated wrapper for the above properties.
    14221422                 */
    14231423                initialize: function ( id, options ) {
    14241424                        var section = this, params;
     
    15451545                 *
    15461546                 * @since 4.1.0
    15471547                 *
    1548                  * @return {Boolean}
     1548                 * @return {boolean}
    15491549                 */
    15501550                isContextuallyActive: function () {
    15511551                        var section = this,
     
    15751575                 *
    15761576                 * @since 4.1.0
    15771577                 *
    1578                  * @param {Boolean} expanded
     1578                 * @param {boolean} expanded
    15791579                 * @param {Object}  args
    15801580                 */
    15811581                onChangeExpanded: function ( expanded, args ) {
     
    16971697                 * @since 4.9.0
    16981698                 *
    16991699                 * @param {string} id - ID.
    1700                  * @param {object} options - Options.
     1700                 * @param {Object} options - Options.
    17011701                 * @return {void}
    17021702                 */
    17031703                initialize: function( id, options ) {
     
    17991799                 *
    18001800                 * @since 4.2.0
    18011801                 *
    1802                  * @return {Boolean}
     1802                 * @return {boolean}
    18031803                 */
    18041804                isContextuallyActive: function () {
    18051805                        return this.active();
     
    19511951                 *
    19521952                 * @since 4.2.0
    19531953                 *
    1954                  * @param {Boolean}  expanded
     1954                 * @param {boolean}  expanded
    19551955                 * @param {Object}   args
    1956                  * @param {Boolean}  args.unchanged
     1956                 * @param {boolean}  args.unchanged
    19571957                 * @param {Function} args.completeCallback
    19581958                 * @return {void}
    19591959                 */
     
    21672167                 *
    21682168                 * @since 4.9.0
    21692169                 * @param {Array} themes - Array of theme data to create controls with.
    2170                  * @param {integer} page - Page of results being loaded.
     2170                 * @param {number} page - Page of results being loaded.
    21712171                 * @return {void}
    21722172                 */
    21732173                loadControls: function( themes, page ) {
     
    24122412                 *
    24132413                 * @since 4.9.0
    24142414                 *
    2415                  * @return {int} Visible count.
     2415                 * @return {number} Visible count.
    24162416                 */
    24172417                getVisibleCount: function() {
    24182418                        return this.contentContainer.find( 'li.customize-control:visible' ).length;
     
    25592559                 *
    25602560                 * @since 4.2.0
    25612561                 *
    2562                  * @param {object} theme - Theme.
     2562                 * @param {Object} theme - Theme.
    25632563                 * @param {Function} [callback] - Callback once the details have been shown.
    25642564                 * @return {void}
    25652565                 */
     
    26672667                 *
    26682668                 * @since 4.9.0
    26692669                 *
    2670                  * @param {Boolean}  expanded - The expanded state to transition to.
     2670                 * @param {boolean}  expanded - The expanded state to transition to.
    26712671                 * @param {Object}   [args] - Args.
    26722672                 * @param {boolean}  [args.unchanged] - Whether the state is already known to not be changed, and so short-circuit with calling completeCallback early.
    26732673                 * @param {Function} [args.completeCallback] - Function to call when the slideUp/slideDown has completed.
     
    27622762                 * @since 4.1.0
    27632763                 *
    27642764                 * @param {string}  id - The ID for the panel.
    2765                  * @param {object}  options - Object containing one property: params.
     2765                 * @param {Object}  options - Object containing one property: params.
    27662766                 * @param {string}  options.title - Title shown when panel is collapsed and expanded.
    27672767                 * @param {string}  [options.description] - Description shown at the top of the panel.
    27682768                 * @param {number}  [options.priority=100] - The sort priority for the panel.
     
    27692769                 * @param {string}  [options.type=default] - The type of the panel. See wp.customize.panelConstructor.
    27702770                 * @param {string}  [options.content] - The markup to be used for the panel container. If empty, a JS template is used.
    27712771                 * @param {boolean} [options.active=true] - Whether the panel is active or not.
    2772                  * @param {object}  [options.params] - Deprecated wrapper for the above properties.
     2772                 * @param {Object}  [options.params] - Deprecated wrapper for the above properties.
    27732773                 */
    27742774                initialize: function ( id, options ) {
    27752775                        var panel = this, params;
     
    29052905                 *
    29062906                 * @since 4.1.0
    29072907                 *
    2908                  * @param {Boolean}  expanded
     2908                 * @param {boolean}  expanded
    29092909                 * @param {Object}   args
    2910                  * @param {Boolean}  args.unchanged
     2910                 * @param {boolean}  args.unchanged
    29112911                 * @param {Function} args.completeCallback
    29122912                 * @return {void}
    29132913                 */
     
    30363036                 * @since 4.9.0
    30373037                 *
    30383038                 * @param {string} id - The ID for the panel.
    3039                  * @param {object} options - Options.
     3039                 * @param {Object} options - Options.
    30403040                 * @return {void}
    30413041                 */
    30423042                initialize: function( id, options ) {
     
    31333133                 *
    31343134                 * @since 4.9.0
    31353135                 *
    3136                  * @param {Boolean}  expanded - Expanded state.
     3136                 * @param {boolean}  expanded - Expanded state.
    31373137                 * @param {Object}   args - Args.
    3138                  * @param {Boolean}  args.unchanged - Whether or not the state changed.
     3138                 * @param {boolean}  args.unchanged - Whether or not the state changed.
    31393139                 * @param {Function} args.completeCallback - Callback to execute when the animation completes.
    31403140                 * @return {void}
    31413141                 */
     
    34823482                 * @borrows wp.customize~Container#_toggleActive as this#_toggleActive
    34833483                 *
    34843484                 * @param {string} id                       - Unique identifier for the control instance.
    3485                  * @param {object} options                  - Options hash for the control instance.
    3486                  * @param {object} options.type             - Type of control (e.g. text, radio, dropdown-pages, etc.)
     3485                 * @param {Object} options                  - Options hash for the control instance.
     3486                 * @param {Object} options.type             - Type of control (e.g. text, radio, dropdown-pages, etc.)
    34873487                 * @param {string} [options.content]        - The HTML content for the control or at least its container. This should normally be left blank and instead supplying a templateId.
    34883488                 * @param {string} [options.templateId]     - Template ID for control's content.
    34893489                 * @param {string} [options.priority=10]    - Order of priority to show the control within the section.
     
    34963496                 * @param {string} options.label            - Label.
    34973497                 * @param {string} options.description      - Description.
    34983498                 * @param {number} [options.instanceNumber] - Order in which this instance was created in relation to other instances.
    3499                  * @param {object} [options.params]         - Deprecated wrapper for the above properties.
     3499                 * @param {Object} [options.params]         - Deprecated wrapper for the above properties.
    35003500                 * @return {void}
    35013501                 */
    35023502                initialize: function( id, options ) {
     
    39003900                 *
    39013901                 * @since 4.1.0
    39023902                 *
    3903                  * @param {Boolean}  active
     3903                 * @param {boolean}  active
    39043904                 * @param {Object}   args
    3905                  * @param {Number}   args.duration
     3905                 * @param {number}   args.duration
    39063906                 * @param {Function} args.completeCallback
    39073907                 */
    39083908                onChangeActive: function ( active, args ) {
     
    43554355                /**
    43564356                 * Called when the "Remove" link is clicked. Empties the setting.
    43574357                 *
    4358                  * @param {object} event jQuery Event object
     4358                 * @param {Object} event jQuery Event object
    43594359                 */
    43604360                removeFile: function( event ) {
    43614361                        if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
     
    45654565                /**
    45664566                 * After the image has been cropped, apply the cropped image data to the setting.
    45674567                 *
    4568                  * @param {object} croppedImage Cropped attachment data.
     4568                 * @param {Object} croppedImage Cropped attachment data.
    45694569                 */
    45704570                onCropped: function( croppedImage ) {
    45714571                        this.setImageFromAttachment( croppedImage );
     
    46414641                /**
    46424642                 * Return whether the image must be cropped, based on required dimensions.
    46434643                 *
    4644                  * @param {bool} flexW
    4645                  * @param {bool} flexH
    4646                  * @param {int}  dstW
    4647                  * @param {int}  dstH
    4648                  * @param {int}  imgW
    4649                  * @param {int}  imgH
    4650                  * @return {bool}
     4644                 * @param {boolean} flexW
     4645                 * @param {boolean} flexH
     4646                 * @param {number}  dstW
     4647                 * @param {number}  dstH
     4648                 * @param {number}  imgW
     4649                 * @param {number}  imgH
     4650                 * @return {boolean}
    46514651                 */
    46524652                mustBeCropped: function( flexW, flexH, dstW, dstH, imgW, imgH ) {
    46534653                        if ( true === flexW && true === flexH ) {
     
    46844684                /**
    46854685                 * Updates the setting and re-renders the control UI.
    46864686                 *
    4687                  * @param {object} attachment
     4687                 * @param {Object} attachment
    46884688                 */
    46894689                setImageFromAttachment: function( attachment ) {
    46904690                        this.params.attachment = attachment;
     
    47704770                /**
    47714771                 * Updates the setting and re-renders the control UI.
    47724772                 *
    4773                  * @param {object} attachment
     4773                 * @param {Object} attachment
    47744774                 */
    47754775                setImageFromAttachment: function( attachment ) {
    47764776                        var sizes = [ 'site_icon-32', 'thumbnail', 'full' ], link,
     
    47994799                /**
    48004800                 * Called when the "Remove" link is clicked. Empties the setting.
    48014801                 *
    4802                  * @param {object} event jQuery Event object
     4802                 * @param {Object} event jQuery Event object
    48034803                 */
    48044804                removeFile: function( event ) {
    48054805                        if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
     
    50095009                /**
    50105010                 * After the image has been cropped, apply the cropped image data to the setting.
    50115011                 *
    5012                  * @param {object} croppedImage Cropped attachment data.
     5012                 * @param {Object} croppedImage Cropped attachment data.
    50135013                 */
    50145014                onCropped: function(croppedImage) {
    50155015                        var url = croppedImage.url,
     
    50225022                /**
    50235023                 * If cropping was skipped, apply the image data directly to the setting.
    50245024                 *
    5025                  * @param {object} selection
     5025                 * @param {Object} selection
    50265026                 */
    50275027                onSkippedCrop: function(selection) {
    50285028                        var url = selection.get('url'),
     
    50365036                 * header image data and inserts it into the user-uploaded headers
    50375037                 * collection.
    50385038                 *
    5039                  * @param {String} url
    5040                  * @param {Number} attachmentId
    5041                  * @param {Number} width
    5042                  * @param {Number} height
     5039                 * @param {string} url
     5040                 * @param {number} attachmentId
     5041                 * @param {number} width
     5042                 * @param {number} height
    50435043                 */
    50445044                setImageFromURL: function(url, attachmentId, width, height) {
    50455045                        var choice, data = {};
     
    52455245                 *
    52465246                 * @since 4.9.0
    52475247                 * @param {string} id      - Unique identifier for the control instance.
    5248                  * @param {object} options - Options hash for the control instance.
     5248                 * @param {Object} options - Options hash for the control instance.
    52495249                 * @return {void}
    52505250                 */
    52515251                initialize: function( id, options ) {
     
    53845384                 * Initialize syntax-highlighting editor.
    53855385                 *
    53865386                 * @since 4.9.0
    5387                  * @param {object} codeEditorSettings - Code editor settings.
     5387                 * @param {Object} codeEditorSettings - Code editor settings.
    53885388                 * @return {void}
    53895389                 */
    53905390                initSyntaxHighlightingEditor: function( codeEditorSettings ) {
     
    56265626                 * @since 4.9.0
    56275627                 *
    56285628                 * @param {string} datetime - Date/Time string. Accepts Y-m-d[ H:i[:s]] format.
    5629                  * @return {object|null} Returns object containing date components or null if parse error.
     5629                 * @return {Object|null} Returns object containing date components or null if parse error.
    56305630                 */
    56315631                parseDateTime: function parseDateTime( datetime ) {
    56325632                        var control = this, matches, date, midDayHour = 12;
     
    62186218                 * @constructs wp.customize.PreviewFrame
    62196219                 * @augments   wp.customize.Messenger
    62206220                 *
    6221                  * @param {object} params.container
    6222                  * @param {object} params.previewUrl
    6223                  * @param {object} params.query
    6224                  * @param {object} options
     6221                 * @param {Object} params.container
     6222                 * @param {Object} params.previewUrl
     6223                 * @param {Object} params.query
     6224                 * @param {Object} options
    62256225                 */
    62266226                initialize: function( params, options ) {
    62276227                        var deferred = $.Deferred();
     
    62486248                /**
    62496249                 * Run the preview request.
    62506250                 *
    6251                  * @param {object} deferred jQuery Deferred object to be resolved with
     6251                 * @param {Object} deferred jQuery Deferred object to be resolved with
    62526252                 *                          the request.
    62536253                 */
    62546254                run: function( deferred ) {
     
    64566456                 * @constructs wp.customize.Previewer
    64576457                 * @augments   wp.customize.Messenger
    64586458                 *
    6459                  * @param {array}  params.allowedUrls
     6459                 * @param {Array}  params.allowedUrls
    64606460                 * @param {string} params.container   A selector or jQuery element for the preview
    64616461                 *                                    frame to be placed.
    64626462                 * @param {string} params.form
    64636463                 * @param {string} params.previewUrl  The URL to preview.
    6464                  * @param {object} options
     6464                 * @param {Object} options
    64656465                 */
    64666466                initialize: function( params, options ) {
    64676467                        var previewer = this,
     
    66096609                 * @since 4.7.0
    66106610                 * @access public
    66116611                 *
    6612                  * @param {object} data - Data from preview.
     6612                 * @param {Object} data - Data from preview.
    66136613                 * @param {string} data.currentUrl - Current URL.
    6614                  * @param {object} data.activePanels - Active panels.
    6615                  * @param {object} data.activeSections Active sections.
    6616                  * @param {object} data.activeControls Active controls.
     6614                 * @param {Object} data.activePanels - Active panels.
     6615                 * @param {Object} data.activeSections Active sections.
     6616                 * @param {Object} data.activeControls Active controls.
    66176617                 * @return {void}
    66186618                 */
    66196619                ready: function( data ) {
     
    69176917         * @since 4.6.0
    69186918         * @private
    69196919         *
    6920          * @param {object}  args
    6921          * @param {object}  args.settingValidities
     6920         * @param {Object}  args
     6921         * @param {Object}  args.settingValidities
    69226922         * @param {boolean} [args.focusInvalidControl=false]
    69236923         * @return {void}
    69246924         */
     
    69936993         *
    69946994         * @since 4.6.0
    69956995         * @param {string[]} settingIds Setting IDs.
    6996          * @return {object<string, wp.customize.Control>} Mapping setting ids to arrays of controls.
     6996         * @return {Object<string, wp.customize.Control>} Mapping setting ids to arrays of controls.
    69976997         */
    69986998        api.findControlsForSettings = function findControlsForSettings( settingIds ) {
    69996999                var controls = {}, settingControls;
     
    74017401                         * @since 4.7.0 Added options param.
    74027402                         * @access public
    74037403                         *
    7404                          * @param {object}  [options] Options.
     7404                         * @param {Object}  [options] Options.
    74057405                         * @param {boolean} [options.excludeCustomizedSaved=false] Exclude saved settings in customized response (values pending writing to changeset).
    7406                          * @return {object} Query vars.
     7406                         * @return {Object} Query vars.
    74077407                         */
    74087408                        query: function( options ) {
    74097409                                var queryVars = {
     
    74397439                         * @since 3.4.0
    74407440                         * @since 4.7.0 Added args param and return value.
    74417441                         *
    7442                          * @param {object} [args] Args.
     7442                         * @param {Object} [args] Args.
    74437443                         * @param {string} [args.status=publish] Status.
    74447444                         * @param {string} [args.date] Date, in local time in MySQL format.
    74457445                         * @param {string} [args.title] Title
     
    81218121                                 * @since 4.9.0
    81228122                                 *
    81238123                                 * @param {string} [code] - Code.
    8124                                  * @param {object} [params] - Params.
     8124                                 * @param {Object} [params] - Params.
    81258125                                 */
    81268126                                initialize: function( code, params ) {
    81278127                                        var notification = this, _code, _params;
     
    82108210                         *
    82118211                         * @since 4.9.0
    82128212                         *
    8213                          * @param {object} [args] - Args.
    8214                          * @param {object} [args.lockUser] - Lock user data.
     8213                         * @param {Object} [args] - Args.
     8214                         * @param {Object} [args.lockUser] - Lock user data.
    82158215                         * @param {boolean} [args.allowOverride=false] - Whether override is allowed.
    82168216                         * @return {void}
    82178217                         */
     
    86378637                         * @since 4.7.0
    86388638                         * @access private
    86398639                         *
    8640                          * @param {object} header - Header.
     8640                         * @param {Object} header - Header.
    86418641                         * @param {number} scrollTop - Scroll top.
    86428642                         * @param {number} scrollDirection - Scroll direction, negative number being up and positive being down.
    86438643                         * @return {void}
  • src/js/_enqueues/wp/customize/nav-menus.js

     
    9595         * @since 4.7.0
    9696         * @alias wp.customize.Menus.insertAutoDraftPost
    9797         *
    98          * @param {object} params - Parameters for the draft post to create.
     98         * @param {Object} params - Parameters for the draft post to create.
    9999         * @param {string} params.post_type - Post type to add.
    100100         * @param {string} params.post_title - Post title to use.
    101101         * @return {jQuery.promise} Promise resolved with the added post.
     
    387387                 * @since 4.7.0 Changed function signature to take list of item types instead of single type/object.
    388388                 * @access private
    389389                 *
    390                  * @param {Array.<object>} itemTypes List of objects containing type and key.
     390                 * @param {Array.<Object>} itemTypes List of objects containing type and key.
    391391                 * @param {string} deprecated Formerly the object parameter.
    392392                 * @return {void}
    393393                 */
     
    905905                 *
    906906                 * @since 4.3.0
    907907                 *
    908                  * @param {String} id
     908                 * @param {string} id
    909909                 * @param {Object} options
    910910                 */
    911911                initialize: function( id, options ) {
     
    22122212                 *
    22132213                 * @private
    22142214                 *
    2215                  * @param {Number} offset 1|-1
     2215                 * @param {number} offset 1|-1
    22162216                 */
    22172217                _changePosition: function( offset ) {
    22182218                        var control = this,
     
    22722272                 *
    22732273                 * @private
    22742274                 *
    2275                  * @param {Number} offset 1|-1
     2275                 * @param {number} offset 1|-1
    22762276                 */
    22772277                _changeDepth: function( offset ) {
    22782278                        if ( 1 !== offset && -1 !== offset ) {
     
    26552655                 * Notice that the UI aspects here are handled by wpNavMenu.initSortables()
    26562656                 * which is called in MenuSection.onChangeExpanded()
    26572657                 *
    2658                  * @param {object} menuList - The element that has sortable().
     2658                 * @param {Object} menuList - The element that has sortable().
    26592659                 */
    26602660                _setupSortable: function( menuList ) {
    26612661                        var control = this;
     
    28542854                /**
    28552855                 * Enable/disable the reordering UI
    28562856                 *
    2857                  * @param {Boolean} showOrHide to enable/disable reordering
     2857                 * @param {boolean} showOrHide to enable/disable reordering
    28582858                 */
    28592859                toggleReordering: function( showOrHide ) {
    28602860                        var addNewItemBtn = this.container.find( '.add-new-menu-item' ),
     
    29942994                /**
    29952995                 * Add a new item to this menu.
    29962996                 *
    2997                  * @param {object} item - Value for the nav_menu_item setting to be created.
     2997                 * @param {Object} item - Value for the nav_menu_item setting to be created.
    29982998                 * @return {wp.customize.Menus.controlConstructor.nav_menu_item} The newly-created nav_menu_item control instance.
    29992999                 */
    30003000                addItemToMenu: function( item ) {
     
    31353135         *
    31363136         * @alias wp.customize.Menus.applySavedData
    31373137         *
    3138          * @param {object} data
    3139          * @param {array} data.nav_menu_updates
    3140          * @param {array} data.nav_menu_item_updates
     3138         * @param {Object} data
     3139         * @param {Array} data.nav_menu_updates
     3140         * @param {Array} data.nav_menu_item_updates
    31413141         */
    31423142        api.Menus.applySavedData = function( data ) {
    31433143
     
    33943394         * @alias wp.customize.Menus.getMenuItemControl
    33953395         *
    33963396         * @param {string} menuItemId
    3397          * @return {object|null}
     3397         * @return {Object|null}
    33983398         */
    33993399        api.Menus.getMenuItemControl = function( menuItemId ) {
    34003400                return api.control( menuItemIdToSettingId( menuItemId ) );
     
    34033403        /**
    34043404         * @alias wp.customize.Menus~menuItemIdToSettingId
    34053405         *
    3406          * @param {String} menuItemId
     3406         * @param {string} menuItemId
    34073407         */
    34083408        function menuItemIdToSettingId( menuItemId ) {
    34093409                return 'nav_menu_item[' + menuItemId + ']';
  • src/js/_enqueues/wp/customize/preview-nav-menus.js

     
    9898                         * @param {string} options.params.navMenuArgs.args_hmac
    9999                         * @param {string} [options.params.navMenuArgs.theme_location]
    100100                         * @param {number} [options.params.navMenuArgs.menu]
    101                          * @param {object} [options.constructingContainerContext]
     101                         * @param {Object} [options.constructingContainerContext]
    102102                         */
    103103                        initialize: function( id, options ) {
    104104                                var partial = this, matches, argsHmac;
     
    132132                         *
    133133                         * @since 4.5.0
    134134                         * @param {wp.customize.Value|string} setting  - Object or ID.
    135                          * @param {number|object|false|null}  newValue - New value, or null if the setting was just removed.
    136                          * @param {number|object|false|null}  oldValue - Old value, or null if the setting was just added.
     135                         * @param {number|Object|false|null}  newValue - New value, or null if the setting was just removed.
     136                         * @param {number|Object|false|null}  oldValue - Old value, or null if the setting was just added.
    137137                         * @return {boolean}
    138138                         */
    139139                        isRelatedSetting: function( setting, newValue, oldValue ) {
     
    263263                /**
    264264                 * Request full refresh if there are nav menu instances that lack partials which also match the supplied args.
    265265                 *
    266                  * @param {object} navMenuInstanceArgs
     266                 * @param {Object} navMenuInstanceArgs
    267267                 */
    268268                self.handleUnplacedNavMenuInstances = function( navMenuInstanceArgs ) {
    269269                        var unplacedNavMenuInstances;
     
    283283                 * @since 4.5.0
    284284                 *
    285285                 * @param {wp.customize.Value} setting
    286                  * @param {object}             [options]
     286                 * @param {Object}             [options]
    287287                 * @param {boolean}            options.fire Whether to invoke the callback after binding.
    288288                 *                                          This is used when a dynamic setting is added.
    289289                 * @return {boolean} Whether the setting was bound.
     
    370370                 *
    371371                 * @since 4.5.0
    372372                 *
    373                  * @param {object} newItem New value for nav_menu_item[] setting.
    374                  * @param {object} oldItem Old value for nav_menu_item[] setting.
     373                 * @param {Object} newItem New value for nav_menu_item[] setting.
     374                 * @param {Object} oldItem Old value for nav_menu_item[] setting.
    375375                 * @this {wp.customize.Value}
    376376                 */
    377377                self.onChangeNavMenuItemSetting = function( newItem, oldItem ) {
  • src/js/_enqueues/wp/customize/preview.js

     
    102102         */
    103103        api.Preview = api.Messenger.extend(/** @lends wp.customize.Preview.prototype */{
    104104                /**
    105                  * @param {object} params  - Parameters to configure the messenger.
    106                  * @param {object} options - Extend any instance parameter or method with this object.
     105                 * @param {Object} params  - Parameters to configure the messenger.
     106                 * @param {Object} options - Extend any instance parameter or method with this object.
    107107                 */
    108108                initialize: function( params, options ) {
    109109                        var preview = this, urlParser = document.createElement( 'a' );
     
    276276         * @param {string} element.search Query string.
    277277         * @param {string} element.pathname Path.
    278278         * @param {string} element.host Host.
    279          * @param {object} [options]
    280          * @param {object} [options.allowAdminAjax=false] Allow admin-ajax.php requests.
     279         * @param {Object} [options]
     280         * @param {Object} [options.allowAdminAjax=false] Allow admin-ajax.php requests.
    281281         * @return {boolean} Is appropriate for changeset link.
    282282         */
    283283        api.isLinkPreviewable = function isLinkPreviewable( element, options ) {
     
    399399                /**
    400400                 * Rewrite Ajax requests to inject customizer state.
    401401                 *
    402                  * @param {object} options Options.
     402                 * @param {Object} options Options.
    403403                 * @param {string} options.type Type.
    404404                 * @param {string} options.url URL.
    405                  * @param {object} originalOptions Original options.
     405                 * @param {Object} originalOptions Original options.
    406406                 * @param {XMLHttpRequest} xhr XHR.
    407407                 * @return {void}
    408408                 */
  • src/js/_enqueues/wp/customize/selective-refresh.js

     
    6060                 * @since 4.5.0
    6161                 *
    6262                 * @param {string} id                      - Unique identifier for the partial instance.
    63                  * @param {object} options                 - Options hash for the partial instance.
     63                 * @param {Object} options                 - Options hash for the partial instance.
    6464                 * @param {string} options.type            - Type of partial (e.g. nav_menu, widget, etc)
    6565                 * @param {string} options.selector        - jQuery selector to find the container element in the page.
    66                  * @param {array}  options.settings        - The IDs for the settings the partial relates to.
     66                 * @param {Array}  options.settings        - The IDs for the settings the partial relates to.
    6767                 * @param {string} options.primarySetting  - The ID for the primary setting the partial renders.
    68                  * @param {bool}   options.fallbackRefresh - Whether to refresh the entire preview in case of a partial refresh failure.
    69                  * @param {object} [options.params]        - Deprecated wrapper for the above properties.
     68                 * @param {boolean}   options.fallbackRefresh - Whether to refresh the entire preview in case of a partial refresh failure.
     69                 * @param {Object} [options.params]        - Deprecated wrapper for the above properties.
    7070                 */
    7171                initialize: function( id, options ) {
    7272                        var partial = this;
     
    285285                 *
    286286                 * @since 4.5.0
    287287                 *
    288                  * @return {String[]}
     288                 * @return {string[]}
    289289                 */
    290290                settings: function() {
    291291                        var partial = this;
     
    406406                 *
    407407                 * @param {Placement}             placement
    408408                 * @param {Element|jQuery}        [placement.container]  - This param will be empty if there was no element matching the selector.
    409                  * @param {string|object|boolean} placement.addedContent - Rendered HTML content, a data object for JS templates to render, or false if no render.
    410                  * @param {object}                [placement.context]    - Optional context information about the container.
     409                 * @param {string|Object|boolean} placement.addedContent - Rendered HTML content, a data object for JS templates to render, or false if no render.
     410                 * @param {Object}                [placement.context]    - Optional context information about the container.
    411411                 * @return {boolean} Whether the rendering was successful and the fallback was not invoked.
    412412                 */
    413413                renderContent: function( placement ) {
     
    602602                 *
    603603                 * @since 4.5.0
    604604                 *
    605                  * @param {object}                   args
     605                 * @param {Object}                   args
    606606                 * @param {Partial}                  args.partial
    607607                 * @param {jQuery|Element}           [args.container]
    608608                 * @param {Node}                     [args.startNode]
    609609                 * @param {Node}                     [args.endNode]
    610                  * @param {object}                   [args.context]
     610                 * @param {Object}                   [args.context]
    611611                 * @param {string}                   [args.addedContent]
    612612                 * @param {jQuery|DocumentFragment}  [args.removedNodes]
    613613                 */
     
    645645         * @since 4.5.0
    646646         * @see wp.customize.previewer.query()
    647647         *
    648          * @return {object}
     648         * @return {Object}
    649649         */
    650650        self.getCustomizeQuery = function() {
    651651                var dirtyCustomized = {};
  • src/js/_enqueues/wp/customize/widgets.js

     
    459459                /**
    460460                 * @param {jQuery.Event} e
    461461                 * @param {jQuery} widget
    462                  * @param {String} newForm
     462                 * @param {string} newForm
    463463                 */
    464464                rss: function( e, widget, newForm ) {
    465465                        var oldWidgetError = widget.find( '.widget-error:first' ),
     
    968968                 *
    969969                 * @since 4.1.0
    970970                 *
    971                  * @param {Boolean}   active
     971                 * @param {boolean}   active
    972972                 * @param {Object}    args
    973973                 * @param {function}  args.completeCallback
    974974                 */
     
    10751075                 * Get the state for an input depending on its type.
    10761076                 *
    10771077                 * @param {jQuery|Element} input
    1078                  * @return {string|boolean|array|*}
     1078                 * @return {string|boolean|Array|*}
    10791079                 * @private
    10801080                 */
    10811081                _getInputState: function( input ) {
     
    10951095                 * Update an input's state based on its type.
    10961096                 *
    10971097                 * @param {jQuery|Element} input
    1098                  * @param {string|boolean|array|*} state
     1098                 * @param {string|boolean|Array|*} state
    10991099                 * @private
    11001100                 */
    11011101                _setInputState: function ( input, state ) {
     
    11431143                 * Submit the widget form via Ajax and get back the updated instance,
    11441144                 * along with the new widget control form to render.
    11451145                 *
    1146                  * @param {object} [args]
     1146                 * @param {Object} [args]
    11471147                 * @param {Object|null} [args.instance=null]  When the model changes, the instance is sent here; otherwise, the inputs from the form are used
    11481148                 * @param {Function|null} [args.complete=null]  Function which is called when the request finishes. Context is bound to the control. First argument is any error. Following arguments are for success.
    1149                  * @param {Boolean} [args.ignoreActiveElement=false] Whether or not updating a field will be deferred if focus is still on the element.
     1149                 * @param {boolean} [args.ignoreActiveElement=false] Whether or not updating a field will be deferred if focus is still on the element.
    11501150                 */
    11511151                updateWidget: function( args ) {
    11521152                        var self = this, instanceOverride, completeCallback, $widgetRoot, $widgetContent,
     
    13981398                /**
    13991399                 * Respond to change in the expanded state.
    14001400                 *
    1401                  * @param {Boolean} expanded
     1401                 * @param {boolean} expanded
    14021402                 * @param {Object} args  merged on top of this.defaultActiveArguments
    14031403                 */
    14041404                onChangeExpanded: function ( expanded, args ) {
     
    14981498                /**
    14991499                 * Get the position (index) of the widget in the containing sidebar
    15001500                 *
    1501                  * @return {Number}
     1501                 * @return {number}
    15021502                 */
    15031503                getWidgetSidebarPosition: function() {
    15041504                        var sidebarWidgetIds, position;
     
    15301530                /**
    15311531                 * @private
    15321532                 *
    1533                  * @param {Number} offset 1|-1
     1533                 * @param {number} offset 1|-1
    15341534                 */
    15351535                _moveWidgetByOne: function( offset ) {
    15361536                        var i, sidebarWidgetsSetting, sidebarWidgetIds, adjacentWidgetId;
     
    15491549                /**
    15501550                 * Toggle visibility of the widget move area
    15511551                 *
    1552                  * @param {Boolean} [showOrHide]
     1552                 * @param {boolean} [showOrHide]
    15531553                 */
    15541554                toggleWidgetMoveArea: function( showOrHide ) {
    15551555                        var self = this, $moveWidgetArea;
     
    20072007                /**
    20082008                 * Enable/disable the reordering UI
    20092009                 *
    2010                  * @param {Boolean} showOrHide to enable/disable reordering
     2010                 * @param {boolean} showOrHide to enable/disable reordering
    20112011                 *
    20122012                 * @todo We should have a reordering state instead and rename this to onChangeReordering
    20132013                 */
     
    20652065
    20662066                /**
    20672067                 * @param {string} widgetId or an id_base for adding a previously non-existing widget.
    2068                  * @return {object|false} widget_form control instance, or false on error.
     2068                 * @return {Object|false} widget_form control instance, or false on error.
    20692069                 */
    20702070                addWidget: function( widgetId ) {
    20712071                        var self = this, controlHtml, $widget, controlType = 'widget_form', controlContainer, controlConstructor,
     
    22462246        /**
    22472247         * Given a widget control, find the sidebar widgets control that contains it.
    22482248         * @param {string} widgetId
    2249          * @return {object|null}
     2249         * @return {Object|null}
    22502250         */
    22512251        api.Widgets.getSidebarWidgetControlContainingWidget = function( widgetId ) {
    22522252                var foundControl = null;
     
    22652265         * Given a widget ID for a widget appearing in the preview, get the widget form control associated with it.
    22662266         *
    22672267         * @param {string} widgetId
    2268          * @return {object|null}
     2268         * @return {Object|null}
    22692269         */
    22702270        api.Widgets.getWidgetFormControlForWidget = function( widgetId ) {
    22712271                var foundControl = null;
     
    23332333        }
    23342334
    23352335        /**
    2336          * @param {String} widgetId
     2336         * @param {string} widgetId
    23372337         * @return {Object}
    23382338         */
    23392339        function parseWidgetId( widgetId ) {
     
    23552355        }
    23562356
    23572357        /**
    2358          * @param {String} widgetId
    2359          * @return {String} settingId
     2358         * @param {string} widgetId
     2359         * @return {string} settingId
    23602360         */
    23612361        function widgetIdToSettingId( widgetId ) {
    23622362                var parsed = parseWidgetId( widgetId ), settingId;
  • src/js/_enqueues/wp/editor/base.js

     
    473473                 * The method directly manipulates the `textarea` content, to allow TinyMCE plugins
    474474                 * to run after the markers are added.
    475475                 *
    476                  * @param {object} $textarea TinyMCE's textarea wrapped as a DomQuery object
     476                 * @param {Object} $textarea TinyMCE's textarea wrapped as a DomQuery object
    477477                 */
    478478                function addHTMLBookmarkInTextAreaContent( $textarea ) {
    479479                        if ( ! $textarea || ! $textarea.length ) {
     
    561561                 * By default TinyMCE wraps loose inline tags in a `<p>`.
    562562                 * When removing selection markers an empty `<p>` may be left behind, remove it.
    563563                 *
    564                  * @param {object} $marker The marker to be removed from the editor DOM, wrapped in an instnce of `editor.$`
     564                 * @param {Object} $marker The marker to be removed from the editor DOM, wrapped in an instnce of `editor.$`
    565565                 */
    566566                function removeSelectionMarker( $marker ) {
    567567                        var $markerParent = $marker.parent();
     
    11321132                 *
    11331133                 * @memberof switchEditors
    11341134                 *
    1135                  * @param {String} html The content from the visual editor.
    1136                  * @return {String} the filtered content.
     1135                 * @param {string} html The content from the visual editor.
     1136                 * @return {string} the filtered content.
    11371137                 */
    11381138                function pre_wpautop( html ) {
    11391139                        var obj = { o: exports, data: html, unfiltered: html };
     
    11581158                 *
    11591159                 * @memberof switchEditors
    11601160                 *
    1161                  * @param {String} text The content from the text editor.
    1162                  * @return {String} filtered content.
     1161                 * @param {string} text The content from the text editor.
     1162                 * @return {string} filtered content.
    11631163                 */
    11641164                function wpautop( text ) {
    11651165                        var obj = { o: exports, data: text, unfiltered: text };
     
    12251225         *
    12261226         * @param {string} id The HTML id of the textarea that is used for the editor.
    12271227         *                    Has to be jQuery compliant. No brackets, special chars, etc.
    1228          * @param {object} settings Example:
     1228         * @param {Object} settings Example:
    12291229         * settings = {
    12301230         *    // See https://www.tinymce.com/docs/configure/integration-and-setup/.
    12311231         *    // Alternatively set to `true` to use the defaults.
  • src/js/_enqueues/wp/editor/dfw.js

     
    204204                        /**
    205205                         * Gets the offset of the editor.
    206206                         *
    207                          * @return {Number|Boolean} Returns the offset of the editor
     207                         * @return {number|boolean} Returns the offset of the editor
    208208                         * or false if there is no offset height.
    209209                         */
    210210                        function mceGetCursorOffset() {
  • src/js/_enqueues/wp/mce-view.js

     
    4646                /**
    4747                 * Registers a new view type.
    4848                 *
    49                  * @param {String} type   The view type.
     49                 * @param {string} type   The view type.
    5050                 * @param {Object} extend An object to extend wp.mce.View.prototype with.
    5151                 */
    5252                register: function( type, extend ) {
     
    5656                /**
    5757                 * Unregisters a view type.
    5858                 *
    59                  * @param {String} type The view type.
     59                 * @param {string} type The view type.
    6060                 */
    6161                unregister: function( type ) {
    6262                        delete views[ type ];
     
    6565                /**
    6666                 * Returns the settings of a view type.
    6767                 *
    68                  * @param {String} type The view type.
     68                 * @param {string} type The view type.
    6969                 *
    7070                 * @return {Function} The view constructor.
    7171                 */
     
    8888                 * replacing any matches with markers,
    8989                 * and creates a new instance for every match.
    9090                 *
    91                  * @param {String} content The string to scan.
     91                 * @param {string} content The string to scan.
    9292                 * @param {tinymce.Editor} editor The editor.
    9393                 *
    94                  * @return {String} The string with markers.
     94                 * @return {string} The string with markers.
    9595                 */
    9696                setMarkers: function( content, editor ) {
    9797                        var pieces = [ { content: content } ],
     
    149149                /**
    150150                 * Create a view instance.
    151151                 *
    152                  * @param {String}  type    The view type.
    153                  * @param {String}  text    The textual representation of the view.
     152                 * @param {string}  type    The view type.
     153                 * @param {string}  text    The textual representation of the view.
    154154                 * @param {Object}  options Options.
    155                  * @param {Boolean} force   Recreate the instance. Optional.
     155                 * @param {boolean} force   Recreate the instance. Optional.
    156156                 *
    157157                 * @return {wp.mce.View} The view instance.
    158158                 */
     
    190190                /**
    191191                 * Get a view instance.
    192192                 *
    193                  * @param {(String|HTMLElement)} object The textual representation of the view or the view node.
     193                 * @param {(string|HTMLElement)} object The textual representation of the view or the view node.
    194194                 *
    195195                 * @return {wp.mce.View} The view instance or undefined.
    196196                 */
     
    207207                 *
    208208                 * @param {HTMLElement} node The view node.
    209209                 *
    210                  * @return {String} The textual representation of the view.
     210                 * @return {string} The textual representation of the view.
    211211                 */
    212212                getText: function( node ) {
    213213                        return decodeURIComponent( $( node ).attr( 'data-wpview-text' ) || '' );
     
    216216                /**
    217217                 * Renders all view nodes that are not yet rendered.
    218218                 *
    219                  * @param {Boolean} force Rerender all view nodes.
     219                 * @param {boolean} force Rerender all view nodes.
    220220                 */
    221221                render: function( force ) {
    222222                        _.each( instances, function( instance ) {
     
    227227                /**
    228228                 * Update the text of a given view node.
    229229                 *
    230                  * @param {String}         text   The new text.
     230                 * @param {string}         text   The new text.
    231231                 * @param {tinymce.Editor} editor The TinyMCE editor instance the view node is in.
    232232                 * @param {HTMLElement}    node   The view node to update.
    233                  * @param {Boolean}        force  Recreate the instance. Optional.
     233                 * @param {boolean}        force  Recreate the instance. Optional.
    234234                 */
    235235                update: function( text, editor, node, force ) {
    236236                        var instance = this.getInstance( node );
     
    317317                /**
    318318                 * Renders all view nodes tied to this view instance that are not yet rendered.
    319319                 *
    320                  * @param {String}  content The content to render. Optional.
    321                  * @param {Boolean} force   Rerender all view nodes tied to this view instance. Optional.
     320                 * @param {string}  content The content to render. Optional.
     321                 * @param {boolean} force   Rerender all view nodes tied to this view instance. Optional.
    322322                 */
    323323                render: function( content, force ) {
    324324                        if ( content != null ) {
     
    385385                 * Gets all view nodes tied to this view instance.
    386386                 *
    387387                 * @param {Function} callback A callback.
    388                  * @param {Boolean}  rendered Get (un)rendered view nodes. Optional.
     388                 * @param {boolean}  rendered Get (un)rendered view nodes. Optional.
    389389                 */
    390390                getNodes: function( callback, rendered ) {
    391391                        this.getEditors( function( editor ) {
     
    473473                 *
    474474                 * @param {*}        content  The content to set.
    475475                 * @param {Function} callback A callback. Optional.
    476                  * @param {Boolean}  rendered Only set for (un)rendered nodes. Optional.
     476                 * @param {boolean}  rendered Only set for (un)rendered nodes. Optional.
    477477                 */
    478478                setContent: function( content, callback, rendered ) {
    479479                        if ( _.isObject( content ) && ( content.sandbox || content.head || content.body.indexOf( '<script' ) !== -1 ) ) {
     
    502502                /**
    503503                 * Sets the content in an iframe for all view nodes tied to this view instance.
    504504                 *
    505                  * @param {String}   head     HTML string to be added to the head of the document.
    506                  * @param {String}   body     HTML string to be added to the body of the document.
     505                 * @param {string}   head     HTML string to be added to the head of the document.
     506                 * @param {string}   body     HTML string to be added to the body of the document.
    507507                 * @param {Function} callback A callback. Optional.
    508                  * @param {Boolean}  rendered Only set for (un)rendered nodes. Optional.
     508                 * @param {boolean}  rendered Only set for (un)rendered nodes. Optional.
    509509                 */
    510510                setIframes: function( head, body, callback, rendered ) {
    511511                        var self = this;
     
    698698                /**
    699699                 * Sets an error for all view nodes tied to this view instance.
    700700                 *
    701                  * @param {String} message  The error message to set.
    702                  * @param {String} dashicon A dashicon ID. Optional. {@link https://developer.wordpress.org/resource/dashicons/}
     701                 * @param {string} message  The error message to set.
     702                 * @param {string} dashicon A dashicon ID. Optional. {@link https://developer.wordpress.org/resource/dashicons/}
    703703                 */
    704704                setError: function( message, dashicon ) {
    705705                        this.setContent(
     
    713713                /**
    714714                 * Tries to find a text match in a given string.
    715715                 *
    716                  * @param {String} content The string to scan.
     716                 * @param {string} content The string to scan.
    717717                 *
    718718                 * @return {Object}
    719719                 */
     
    734734                /**
    735735                 * Update the text of a given view node.
    736736                 *
    737                  * @param {String}         text   The new text.
     737                 * @param {string}         text   The new text.
    738738                 * @param {tinymce.Editor} editor The TinyMCE editor instance the view node is in.
    739739                 * @param {HTMLElement}    node   The view node to update.
    740                  * @param {Boolean}        force  Recreate the instance. Optional.
     740                 * @param {boolean}        force  Recreate the instance. Optional.
    741741                 */
    742742                update: function( text, editor, node, force ) {
    743743                        _.find( views, function( view, type ) {
  • src/js/_enqueues/wp/media/editor.js

     
    1919         *   passed as an input that expects booleans. If key is undefined in the map,
    2020         *   but has a default value, set it.
    2121         *
    22          * @param {object} attrs Map of props from a shortcode or settings.
     22         * @param {Object} attrs Map of props from a shortcode or settings.
    2323         * @param {string} key The key within the passed map to check for a value.
    2424         * @return {mixed|undefined} The original or coerced value of key within attrs.
    2525         */
  • src/js/_enqueues/wp/media/models.js

     
    1717 * @memberOf wp
    1818 * @namespace
    1919 *
    20  * @param {object} attributes The properties passed to the main media controller.
     20 * @param {Object} attributes The properties passed to the main media controller.
    2121 * @return {wp.media.view.MediaFrame} A media workflow.
    2222 */
    2323media = wp.media = function( attributes ) {
     
    183183         * Truncates a string by injecting an ellipsis into the middle.
    184184         * Useful for filenames.
    185185         *
    186          * @param {String} string
    187          * @param {Number} [length=30]
    188          * @param {String} [replacement=&hellip;]
    189          * @return {String} The string, unless length is greater than string.length.
     186         * @param {string} string
     187         * @param {number} [length=30]
     188         * @param {string} [replacement=&hellip;]
     189         * @return {string} The string, unless length is greater than string.length.
    190190         */
    191191        truncate: function( string, length, replacement ) {
    192192                length = length || 30;
     
    209209 * wp.media.attachment
    210210 *
    211211 * @static
    212  * @param {String} id A string used to identify a model.
     212 * @param {string} id A string used to identify a model.
    213213 * @return {wp.media.model.Attachment}
    214214 */
    215215media.attachment = function( id ) {
     
    229229 *
    230230 * Shorthand for creating a new Attachments Query.
    231231 *
    232  * @param {object} [props]
     232 * @param {Object} [props]
    233233 * @return {wp.media.model.Attachments}
    234234 */
    235235media.query = function( props ) {
  • src/js/_enqueues/wp/media/views.js

     
    4848 * Makes it easier to bind events using transitions.
    4949 *
    5050 * @param {string} selector
    51  * @param {Number} sensitivity
     51 * @param {number} sensitivity
    5252 * @return {Promise}
    5353 */
    5454media.transition = function( selector, sensitivity ) {
  • src/js/_enqueues/wp/theme-plugin-editor.js

     
    2727         * @since 4.9.0
    2828         *
    2929         * @param {jQuery}         form - Form element.
    30          * @param {object}         settings - Settings.
    31          * @param {object|boolean} settings.codeEditor - Code editor settings (or `false` if syntax highlighting is disabled).
     30         * @param {Object}         settings - Settings.
     31         * @param {Object|boolean} settings.codeEditor - Code editor settings (or `false` if syntax highlighting is disabled).
    3232         * @return {void}
    3333         */
    3434        component.init = function init( form, settings ) {
     
    117117         * Constrain tabbing within the warning modal.
    118118         *
    119119         * @since 4.9.0
    120          * @param {object} event jQuery event object.
     120         * @param {Object} event jQuery event object.
    121121         * @return {void}
    122122         */
    123123        component.constrainTabbing = function( event ) {
     
    254254         *
    255255         * @since 4.9.0
    256256         *
    257          * @param {object}   notice - Notice.
     257         * @param {Object}   notice - Notice.
    258258         * @param {string}   notice.code - Code.
    259259         * @param {string}   notice.type - Type.
    260260         * @param {string}   notice.message - Message.
  • src/js/_enqueues/wp/theme.js

     
    14281428 * @since 4.9.0
    14291429 *
    14301430 * @param {string} url - URL to navigate to.
    1431  * @param {object} state - State.
     1431 * @param {Object} state - State.
    14321432 * @return {void}
    14331433 */
    14341434function navigateRouter( url, state ) {
     
    18411841        /**
    18421842         * Get the checked filters.
    18431843         *
    1844          * @return {array} of tags or false
     1844         * @return {Array} of tags or false
    18451845         */
    18461846        filtersChecked: function() {
    18471847                var items = $( '.filter-group' ).find( ':checkbox' ),
  • src/js/_enqueues/wp/updates.js

     
    150150         *
    151151         * @since 4.6.0
    152152         *
    153          * @param {object}  data
     153         * @param {Object}  data
    154154         * @param {*=}      data.selector      Optional. Selector of an element to be replaced with the admin notice.
    155155         * @param {string=} data.id            Optional. Unique id that will be used as the notice's id attribute.
    156156         * @param {string=} data.className     Optional. Class names that will be used in the admin notice.
     
    194194         * @since 4.6.0
    195195         *
    196196         * @param {string} action The type of Ajax request ('update-plugin', 'install-theme', etc).
    197          * @param {object} data   Data that needs to be passed to the ajax callback.
     197         * @param {Object} data   Data that needs to be passed to the ajax callback.
    198198         * @return {$.promise}    A jQuery promise that represents the request,
    199199         *                        decorated with an abort() method.
    200200         */
     
    243243         *
    244244         * @since 4.6.0
    245245         *
    246          * @param {object}  response
    247          * @param {array=}  response.debug     Optional. Debug information.
     246         * @param {Object}  response
     247         * @param {Array=}  response.debug     Optional. Debug information.
    248248         * @param {string=} response.errorCode Optional. Error code for an error that occurred.
    249249         */
    250250        wp.updates.ajaxAlways = function( response ) {
     
    355355         * @since 4.2.0
    356356         * @since 4.6.0 More accurately named `updatePlugin`.
    357357         *
    358          * @param {object}               args         Arguments.
     358         * @param {Object}               args         Arguments.
    359359         * @param {string}               args.plugin  Plugin basename.
    360360         * @param {string}               args.slug    Plugin slug.
    361361         * @param {updatePluginSuccess=} args.success Optional. Success callback. Default: wp.updates.updatePluginSuccess
     
    412412         * @since 4.6.0 More accurately named `updatePluginSuccess`.
    413413         * @since 5.5.0 Auto-update "time to next update" text cleared.
    414414         *
    415          * @param {object} response            Response from the server.
     415         * @param {Object} response            Response from the server.
    416416         * @param {string} response.slug       Slug of the plugin to be updated.
    417417         * @param {string} response.plugin     Basename of the plugin to be updated.
    418418         * @param {string} response.pluginName Name of the plugin to be updated.
     
    466466         * @since 4.2.0
    467467         * @since 4.6.0 More accurately named `updatePluginError`.
    468468         *
    469          * @param {object}  response              Response from the server.
     469         * @param {Object}  response              Response from the server.
    470470         * @param {string}  response.slug         Slug of the plugin to be updated.
    471471         * @param {string}  response.plugin       Basename of the plugin to be updated.
    472472         * @param {string=} response.pluginName   Optional. Name of the plugin to be updated.
     
    562562         *
    563563         * @since 4.6.0
    564564         *
    565          * @param {object}                args         Arguments.
     565         * @param {Object}                args         Arguments.
    566566         * @param {string}                args.slug    Plugin identifier in the WordPress.org Plugin repository.
    567567         * @param {installPluginSuccess=} args.success Optional. Success callback. Default: wp.updates.installPluginSuccess
    568568         * @param {installPluginError=}   args.error   Optional. Error callback. Default: wp.updates.installPluginError
     
    613613         *
    614614         * @since 4.6.0
    615615         *
    616          * @param {object} response             Response from the server.
     616         * @param {Object} response             Response from the server.
    617617         * @param {string} response.slug        Slug of the installed plugin.
    618618         * @param {string} response.pluginName  Name of the installed plugin.
    619619         * @param {string} response.activateUrl URL to activate the just installed plugin.
     
    678678         *
    679679         * @since 4.6.0
    680680         *
    681          * @param {object}  response              Response from the server.
     681         * @param {Object}  response              Response from the server.
    682682         * @param {string}  response.slug         Slug of the plugin to be installed.
    683683         * @param {string=} response.pluginName   Optional. Name of the plugin to be installed.
    684684         * @param {string}  response.errorCode    Error code for the error that occurred.
     
    739739         *
    740740         * @since 4.6.0
    741741         *
    742          * @param {object} response             Response from the server.
     742         * @param {Object} response             Response from the server.
    743743         * @param {string} response.slug        Slug of the installed plugin.
    744744         * @param {string} response.pluginName  Name of the installed plugin.
    745745         * @param {string} response.activateUrl URL to activate the just installed plugin.
     
    778778         *
    779779         * @since 4.6.0
    780780         *
    781          * @param {object}  response              Response from the server.
     781         * @param {Object}  response              Response from the server.
    782782         * @param {string}  response.slug         Slug of the plugin to be installed.
    783783         * @param {string=} response.pluginName   Optional. Name of the plugin to be installed.
    784784         * @param {string}  response.errorCode    Error code for the error that occurred.
     
    829829         *
    830830         * @since 4.6.0
    831831         *
    832          * @param {object}               args         Arguments.
     832         * @param {Object}               args         Arguments.
    833833         * @param {string}               args.plugin  Basename of the plugin to be deleted.
    834834         * @param {string}               args.slug    Slug of the plugin to be deleted.
    835835         * @param {deletePluginSuccess=} args.success Optional. Success callback. Default: wp.updates.deletePluginSuccess
     
    956956         *
    957957         * @since 4.6.0
    958958         *
    959          * @param {object}  response              Response from the server.
     959         * @param {Object}  response              Response from the server.
    960960         * @param {string}  response.slug         Slug of the plugin to be deleted.
    961961         * @param {string}  response.plugin       Base name of the plugin to be deleted
    962962         * @param {string=} response.pluginName   Optional. Name of the plugin to be deleted.
     
    10131013         *
    10141014         * @since 4.6.0
    10151015         *
    1016          * @param {object}              args         Arguments.
     1016         * @param {Object}              args         Arguments.
    10171017         * @param {string}              args.slug    Theme stylesheet.
    10181018         * @param {updateThemeSuccess=} args.success Optional. Success callback. Default: wp.updates.updateThemeSuccess
    10191019         * @param {updateThemeError=}   args.error   Optional. Error callback. Default: wp.updates.updateThemeError
     
    10691069         * @since 4.6.0
    10701070         * @since 5.5.0 Auto-update "time to next update" text cleared.
    10711071         *
    1072          * @param {object} response
     1072         * @param {Object} response
    10731073         * @param {string} response.slug       Slug of the theme to be updated.
    1074          * @param {object} response.theme      Updated theme.
     1074         * @param {Object} response.theme      Updated theme.
    10751075         * @param {string} response.oldVersion Old version of the theme.
    10761076         * @param {string} response.newVersion New version of the theme.
    10771077         */
     
    11341134         *
    11351135         * @since 4.6.0
    11361136         *
    1137          * @param {object} response              Response from the server.
     1137         * @param {Object} response              Response from the server.
    11381138         * @param {string} response.slug         Slug of the theme to be updated.
    11391139         * @param {string} response.errorCode    Error code for the error that occurred.
    11401140         * @param {string} response.errorMessage The error that occurred.
     
    11841184         *
    11851185         * @since 4.6.0
    11861186         *
    1187          * @param {object}               args
     1187         * @param {Object}               args
    11881188         * @param {string}               args.slug    Theme stylesheet.
    11891189         * @param {installThemeSuccess=} args.success Optional. Success callback. Default: wp.updates.installThemeSuccess
    11901190         * @param {installThemeError=}   args.error   Optional. Error callback. Default: wp.updates.installThemeError
     
    12311231         *
    12321232         * @since 4.6.0
    12331233         *
    1234          * @param {object} response              Response from the server.
     1234         * @param {Object} response              Response from the server.
    12351235         * @param {string} response.slug         Slug of the theme to be installed.
    12361236         * @param {string} response.customizeUrl URL to the Customizer for the just installed theme.
    12371237         * @param {string} response.activateUrl  URL to activate the just installed theme.
     
    13101310         *
    13111311         * @since 4.6.0
    13121312         *
    1313          * @param {object} response              Response from the server.
     1313         * @param {Object} response              Response from the server.
    13141314         * @param {string} response.slug         Slug of the theme to be installed.
    13151315         * @param {string} response.errorCode    Error code for the error that occurred.
    13161316         * @param {string} response.errorMessage The error that occurred.
     
    13761376         *
    13771377         * @since 4.6.0
    13781378         *
    1379          * @param {object}              args
     1379         * @param {Object}              args
    13801380         * @param {string}              args.slug    Theme stylesheet.
    13811381         * @param {deleteThemeSuccess=} args.success Optional. Success callback. Default: wp.updates.deleteThemeSuccess
    13821382         * @param {deleteThemeError=}   args.error   Optional. Error callback. Default: wp.updates.deleteThemeError
     
    14181418         *
    14191419         * @since 4.6.0
    14201420         *
    1421          * @param {object} response      Response from the server.
     1421         * @param {Object} response      Response from the server.
    14221422         * @param {string} response.slug Slug of the theme that was deleted.
    14231423         */
    14241424        wp.updates.deleteThemeSuccess = function( response ) {
     
    14761476         *
    14771477         * @since 4.6.0
    14781478         *
    1479          * @param {object} response              Response from the server.
     1479         * @param {Object} response              Response from the server.
    14801480         * @param {string} response.slug         Slug of the theme to be deleted.
    14811481         * @param {string} response.errorCode    Error code for the error that occurred.
    14821482         * @param {string} response.errorMessage The error that occurred.
     
    15311531         * @since 4.6.0
    15321532         * @private
    15331533         *
    1534          * @param {object} data   Ajax payload.
     1534         * @param {Object} data   Ajax payload.
    15351535         * @param {string} action The type of request to perform.
    1536          * @return {object} The Ajax payload with the appropriate callbacks.
     1536         * @return {Object} The Ajax payload with the appropriate callbacks.
    15371537         */
    15381538        wp.updates._addCallbacks = function( data, action ) {
    15391539                if ( 'import' === pagenow && 'install-plugin' === action ) {
     
    17251725         *
    17261726         * @since 4.2.0
    17271727         *
    1728          * @param {object} response Ajax response.
     1728         * @param {Object} response Ajax response.
    17291729         * @param {string} action   The type of request to perform.
    17301730         */
    17311731        wp.updates.credentialError = function( response, action ) {
     
    17531753         *
    17541754         * @since 4.6.0
    17551755         *
    1756          * @param {object} response              Response from the server.
     1756         * @param {Object} response              Response from the server.
    17571757         * @param {string} response.errorCode    Error code for the error that occurred.
    17581758         * @param {string} response.errorMessage The error that occurred.
    17591759         * @param {string} action                The type of request to perform.
     
    17731773         *
    17741774         * If the response deems to be invalid, an admin notice is being displayed.
    17751775         *
    1776          * @param {(object|string)} response              Response from the server.
     1776         * @param {(Object|string)} response              Response from the server.
    17771777         * @param {function=}       response.always       Optional. Callback for when the Deferred is resolved or rejected.
    17781778         * @param {string=}         response.statusText   Optional. Status message corresponding to the status code.
    17791779         * @param {string=}         response.responseText Optional. Request response as text.
  • src/js/_enqueues/wp/util.js

     
    5656                 *
    5757