Changeset 46800
- Timestamp:
- 11/29/2019 05:59:47 PM (5 years ago)
- Location:
- trunk/src/js
- Files:
-
- 86 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/js/_enqueues/admin/comment.js
r43347 r46800 28 28 * 29 29 * @param {Event} event The event object. 30 * @return s{void}30 * @return {void} 31 31 */ 32 32 $edittimestamp.click( function( event ) { … … 47 47 * 48 48 * @param {Event} event The event object. 49 * @return s{void}49 * @return {void} 50 50 */ 51 51 … … 69 69 * 70 70 * @param {Event} event The event object. 71 * @return s{void}71 * @return {void} 72 72 */ 73 73 $timestampdiv.find('.save-timestamp').click( function( event ) { // crazyhorse - multiple ok cancels -
trunk/src/js/_enqueues/admin/common.js
r46250 r46800 43 43 * @since 2.7.0 44 44 * 45 * @return s{void}45 * @return {void} 46 46 */ 47 47 init : function() { … … 65 65 * @since 3.0.0 66 66 * 67 * @return s{void}67 * @return {void} 68 68 */ 69 69 saveManageColumnsState : function() { … … 83 83 * @param {string} column The column name. 84 84 * 85 * @return s{void}85 * @return {void} 86 86 */ 87 87 checked : function(column) { … … 96 96 * @param {string} column The column name. 97 97 * 98 * @return s{void}98 * @return {void} 99 99 */ 100 100 unchecked : function(column) { … … 108 108 * @since 3.0.0 109 109 * 110 * @return s{string} The hidden column names separated by a comma.110 * @return {string} The hidden column names separated by a comma. 111 111 */ 112 112 hidden : function() { … … 121 121 * @since 3.0.0 122 122 * 123 * @return s{string} String containing the checked column names.123 * @return {string} String containing the checked column names. 124 124 */ 125 125 useCheckboxesForHidden : function() { … … 157 157 * @param {jQuery} form The form to validate. 158 158 * 159 * @return s{boolean} Returns true if all required fields are not an empty string.159 * @return {boolean} Returns true if all required fields are not an empty string. 160 160 */ 161 161 window.validateForm = function( form ) { … … 177 177 * @type {{warn: showNotice.warn, note: showNotice.note}} 178 178 * 179 * @return s{void}179 * @return {void} 180 180 */ 181 181 window.showNotice = { … … 186 186 * @since 2.7.0 187 187 * 188 * @return s{boolean} Returns true if the message is confirmed.188 * @return {boolean} Returns true if the message is confirmed. 189 189 */ 190 190 warn : function() { … … 218 218 * close: screenMeta.close}} 219 219 * 220 * @return s{void}220 * @return {void} 221 221 */ 222 222 window.screenMeta = { … … 230 230 * @since 3.2.0 231 231 * 232 * @return s{void}232 * @return {void} 233 233 */ 234 234 init: function() { … … 245 245 * @since 3.2.0 246 246 * 247 * @return s{void}247 * @return {void} 248 248 */ 249 249 toggleEvent: function() { … … 267 267 * @param {jQuery} button The toggle button. 268 268 * 269 * @return s{void}269 * @return {void} 270 270 */ 271 271 open: function( panel, button ) { … … 280 280 * @since 3.2.0 281 281 * 282 * @return s{void}282 * @return {void} 283 283 */ 284 284 panel.slideDown( 'fast', function() { … … 298 298 * @param {jQuery} button The toggle button. 299 299 * 300 * @return s{void}300 * @return {void} 301 301 */ 302 302 close: function( panel, button ) { … … 306 306 * @since 3.2.0 307 307 * 308 * @return s{void}308 * @return {void} 309 309 */ 310 310 panel.slideUp( 'fast', function() { … … 323 323 * @param {Event} e The event object. 324 324 * 325 * @return s{void}325 * @return {void} 326 326 */ 327 327 $('.contextual-help-tabs').delegate('a', 'click', function(e) { … … 504 504 * @param {Event} e The event object. 505 505 * 506 * @return s{void}506 * @return {void} 507 507 */ 508 508 $adminmenu.on('click.wp-submenu-head', '.wp-submenu-head', function(e){ … … 513 513 * Collapses the admin menu. 514 514 * 515 * @return s{void}515 * @return {void} 516 516 */ 517 517 $( '#collapse-button' ).on( 'click.collapse-menu', function() { … … 552 552 * @since 4.4.0 553 553 * 554 * @return s{void}554 * @return {void} 555 555 */ 556 556 function currentMenuItemHasPopup() { … … 575 575 * @param {jQuery} $menuItem The parent menu item containing the submenu. 576 576 * 577 * @return s{void}577 * @return {void} 578 578 */ 579 579 function adjustSubmenu( $menuItem ) { … … 614 614 * @param {Event} e The event object. 615 615 * 616 * @return s{void}616 * @return {void} 617 617 */ 618 618 $body.on( mobileEvent+'.wp-mobile-hover', function(e) { … … 631 631 * @param {Event} event The event object. 632 632 * 633 * @return s{void}633 * @return {void} 634 634 */ 635 635 $adminmenu.find( 'a.wp-has-submenu' ).on( mobileEvent + '.wp-mobile-hover', function( event ) { … … 658 658 * Opens the submenu when hovered over the menu item for desktops. 659 659 * 660 * @return s{void}660 * @return {void} 661 661 */ 662 662 over: function() { … … 682 682 * Closes the submenu when no longer hovering the menu item. 683 683 * 684 * @return s{void}684 * @return {void} 685 685 */ 686 686 out: function(){ … … 702 702 * @param {Event} event The event object. 703 703 * 704 * @return s{void}704 * @return {void} 705 705 */ 706 706 $adminmenu.on( 'focus.adminmenu', '.wp-submenu a', function( event ) { … … 717 717 * @param {Event} event The event object. 718 718 * 719 * @return s{void}719 * @return {void} 720 720 */ 721 721 }).on( 'blur.adminmenu', '.wp-submenu a', function( event ) { … … 729 729 * Adjusts the size for the submenu. 730 730 * 731 * @return s{void}731 * @return {void} 732 732 */ 733 733 }).find( 'li.wp-has-submenu.wp-not-current-submenu' ).on( 'focusin.adminmenu', function() { … … 752 752 * @since 4.4.0 753 753 * 754 * @return s{void}754 * @return {void} 755 755 */ 756 756 function makeNoticesDismissible() { … … 785 785 * This event needs to be delegated. Ticket #37973. 786 786 * 787 * @return s{boolean} Returns whether a checkbox is checked or not.787 * @return {boolean} Returns whether a checkbox is checked or not. 788 788 */ 789 789 $body.on( 'click', 'tbody > tr > .check-column :checkbox', function( event ) { … … 814 814 * Determines if all checkboxes are checked. 815 815 * 816 * @return s{boolean} Returns true if there are no unchecked checkboxes.816 * @return {boolean} Returns true if there are no unchecked checkboxes. 817 817 */ 818 818 $(this).closest('table').children('thead, tfoot').find(':checkbox').prop('checked', function() { … … 833 833 * @param {Event} event The event object. 834 834 * 835 * @return s{boolean}835 * @return {boolean} 836 836 */ 837 837 $body.on( 'click.wp-toggle-checkboxes', 'thead .check-column :checkbox, tfoot .check-column :checkbox', function( event ) { … … 846 846 * Updates the checked state on the checkbox in the table. 847 847 * 848 * @return s{boolean} True checks the checkbox, False unchecks the checkbox.848 * @return {boolean} True checks the checkbox, False unchecks the checkbox. 849 849 */ 850 850 .prop('checked', function() { … … 868 868 * Syncs the bulk checkboxes on the top and bottom of the table. 869 869 * 870 * @return s{boolean} True checks the checkbox, False unchecks the checkbox.870 * @return {boolean} True checks the checkbox, False unchecks the checkbox. 871 871 */ 872 872 .prop('checked', function() { … … 884 884 * Shows row actions on focus of its parent container element or any other elements contained within. 885 885 * 886 * @return s{void}886 * @return {void} 887 887 */ 888 888 $( '#wpbody-content' ).on({ … … 919 919 * @param {Event} e The event object. 920 920 * 921 * @return s{void}921 * @return {void} 922 922 */ 923 923 $('#newcontent').bind('keydown.wpevent_InsertTab', function(e) { … … 978 978 * The form closest to the pageInput is the post-filter form. 979 979 * 980 * @return s{void}980 * @return {void} 981 981 */ 982 982 pageInput.closest('form').submit( function() { … … 993 993 * Resets the bulk actions when the search button is clicked. 994 994 * 995 * @return s{void}995 * @return {void} 996 996 */ 997 997 $('.search-box input[type="search"], .search-box input[type="submit"]').mousedown(function () { … … 1004 1004 * @param {Event} e The event object. 1005 1005 * 1006 * @return s{void}1006 * @return {void} 1007 1007 */ 1008 1008 $('#contextual-help-link, #show-settings-link').on( 'focus.scroll-into-view', function(e){ … … 1014 1014 * Disables the submit upload buttons when no data is entered. 1015 1015 * 1016 * @return s{void}1016 * @return {void} 1017 1017 */ 1018 1018 (function(){ … … 1031 1031 * @since 3.5.0 1032 1032 * 1033 * @return s{void}1033 * @return {void} 1034 1034 */ 1035 1035 function toggleUploadButton() { … … 1053 1053 * @since 4.1.0 1054 1054 * 1055 * @return s{void}1055 * @return {void} 1056 1056 */ 1057 1057 function pinMenu( event ) { … … 1196 1196 * @since 4.1.0 1197 1197 * 1198 * @return s{void}1198 * @return {void} 1199 1199 */ 1200 1200 function resetHeights() { … … 1212 1212 * @since 4.1.0 1213 1213 * 1214 * @return s{void}1214 * @return {void} 1215 1215 */ 1216 1216 function unpinMenu() { … … 1232 1232 * @since 4.1.0 1233 1233 * 1234 * @return s{void}1234 * @return {void} 1235 1235 */ 1236 1236 function setPinMenu() { … … 1261 1261 * @since 3.8.0 1262 1262 * 1263 * @returns{void}1263 * @return {void} 1264 1264 */ 1265 1265 window.wpResponsive = { … … 1270 1270 * @since 3.8.0 1271 1271 * 1272 * @return s{void}1272 * @return {void} 1273 1273 */ 1274 1274 init: function() { … … 1328 1328 * @since 5.3.0 1329 1329 * 1330 * @return s{void}1330 * @return {void} 1331 1331 */ 1332 1332 maybeDisableSortables: function() { … … 1351 1351 * @since 3.8.0 1352 1352 * 1353 * @return s{void}1353 * @return {void} 1354 1354 */ 1355 1355 activate: function() { … … 1372 1372 * @since 3.8.0 1373 1373 * 1374 * @return s{void}1374 * @return {void} 1375 1375 */ 1376 1376 deactivate: function() { … … 1386 1386 * @since 3.8.0 1387 1387 * 1388 * @return s{void}1388 * @return {void} 1389 1389 */ 1390 1390 trigger: function() { … … 1422 1422 * @since 3.8.0 1423 1423 * 1424 * @return s{void}1424 * @return {void} 1425 1425 */ 1426 1426 enableOverlay: function() { … … 1445 1445 * @since 3.8.0 1446 1446 * 1447 * @return s{void}1447 * @return {void} 1448 1448 */ 1449 1449 disableOverlay: function() { … … 1457 1457 * @since 3.8.0 1458 1458 * 1459 * @return s{void}1459 * @return {void} 1460 1460 */ 1461 1461 disableSortables: function() { … … 1473 1473 * @since 3.8.0 1474 1474 * 1475 * @return s{void}1475 * @return {void} 1476 1476 */ 1477 1477 enableSortables: function() { … … 1490 1490 * @since 4.5.0 1491 1491 * 1492 * @return s{void}1492 * @return {void} 1493 1493 */ 1494 1494 function aria_button_if_js() { … … 1505 1505 * @since 4.7.0 1506 1506 * 1507 * @return s{number|boolean} The current viewport width or false if the1508 * 1507 * @return {number|boolean} The current viewport width or false if the 1508 * browser doesn't support innerWidth (IE < 9). 1509 1509 */ 1510 1510 function getViewportWidth() { … … 1527 1527 * @since 4.7.0 1528 1528 * 1529 * @return s{void}1529 * @return {void} 1530 1530 */ 1531 1531 function setMenuState() { … … 1555 1555 * @since 4.7.0 1556 1556 * 1557 * @return s{void}1557 * @return {void} 1558 1558 */ 1559 1559 $document.on( 'wp-menu-state-set wp-collapse-menu', function( event, eventData ) { … … 1614 1614 * @since 3.8.0 1615 1615 * 1616 * @return s{void}1616 * @return {void} 1617 1617 */ 1618 1618 function triggerEvent() { … … 1625 1625 * @since 3.8.0 1626 1626 * 1627 * @return s{void}1627 * @return {void} 1628 1628 */ 1629 1629 function fireOnce() { -
trunk/src/js/_enqueues/admin/custom-background.js
r43347 r46800 22 22 * @since 3.5.0 23 23 * 24 * @return s{void}24 * @return {void} 25 25 */ 26 26 $('#background-color').wpColorPicker({ … … 38 38 * @since 4.7.0 39 39 * 40 * @return s{void}40 * @return {void} 41 41 */ 42 42 $( 'select[name="background-size"]' ).change( function() { … … 49 49 * @since 4.7.0 50 50 * 51 * @return s{void}51 * @return {void} 52 52 */ 53 53 $( 'input[name="background-position"]' ).change( function() { … … 60 60 * @since 3.0.0 61 61 * 62 * @return s{void}62 * @return {void} 63 63 */ 64 64 $( 'input[name="background-repeat"]' ).change( function() { … … 71 71 * @since 4.7.0 72 72 * 73 * @return s{void}73 * @return {void} 74 74 */ 75 75 $( 'input[name="background-attachment"]' ).change( function() { … … 82 82 * @since 3.5.0 83 83 * 84 * @return s{void}84 * @return {void} 85 85 */ 86 86 $('#choose-from-library-link').click( function( event ) { … … 122 122 * @since 3.5.0 123 123 * 124 * @return s{void}124 * @return {void} 125 125 */ 126 126 frame.on( 'select', function() { -
trunk/src/js/_enqueues/admin/custom-header.js
r43347 r46800 34 34 * @deprecated 4.1.0 35 35 * 36 * @return s{void}36 * @return {void} 37 37 */ 38 38 $('#choose-from-library-link').click( function( event ) { … … 72 72 * @deprecated 4.1.0 73 73 * 74 * @return s{void}74 * @return {void} 75 75 */ 76 76 frame.on( 'select', function() { -
trunk/src/js/_enqueues/admin/inline-edit-post.js
r45417 r46800 37 37 * @since 2.7.0 38 38 * 39 * @return s{void}39 * @return {void} 40 40 */ 41 41 init : function(){ … … 49 49 * Binds the escape key to revert the changes and close the quick editor. 50 50 * 51 * @return s{boolean} The result of revert.51 * @return {boolean} The result of revert. 52 52 */ 53 53 qeRow.keyup(function(e){ … … 61 61 * Binds the escape key to revert the changes and close the bulk editor. 62 62 * 63 * @return s{boolean} The result of revert.63 * @return {boolean} The result of revert. 64 64 */ 65 65 bulkRow.keyup(function(e){ … … 73 73 * Reverts changes and close the quick editor if the cancel button is clicked. 74 74 * 75 * @return s{boolean} The result of revert.75 * @return {boolean} The result of revert. 76 76 */ 77 77 $( '.cancel', qeRow ).click( function() { … … 82 82 * Saves changes in the quick editor if the save(named: update) button is clicked. 83 83 * 84 * @return s{boolean} The result of save.84 * @return {boolean} The result of save. 85 85 */ 86 86 $( '.save', qeRow ).click( function() { … … 91 91 * If enter is pressed, and the target is not the cancel button, save the post. 92 92 * 93 * @return s{boolean} The result of save.93 * @return {boolean} The result of save. 94 94 */ 95 95 $('td', qeRow).keydown(function(e){ … … 102 102 * Reverts changes and close the bulk editor if the cancel button is clicked. 103 103 * 104 * @return s{boolean} The result of revert.104 * @return {boolean} The result of revert. 105 105 */ 106 106 $( '.cancel', bulkRow ).click( function() { … … 248 248 * @param {number|Object} id The id of the clicked post or an element within a post 249 249 * table row. 250 * @return s{boolean} Always returns false at the end of execution.250 * @return {boolean} Always returns false at the end of execution. 251 251 */ 252 252 edit : function(id) { … … 286 286 * Replaces the image for a Twemoji(Twitter emoji) with it's alternate text. 287 287 * 288 * @return sAlternate text from the image.288 * @return {string} Alternate text from the image. 289 289 */ 290 290 val.find( 'img' ).replaceWith( function() { return this.alt; } ); … … 386 386 * @since 2.7.0 387 387 * 388 * @param 389 * @return s {boolean} false, so the form does not submit when pressing390 * 388 * @param {int} id The id for the post that has been changed. 389 * @return {boolean} False, so the form does not submit when pressing 390 * Enter on a focused field. 391 391 */ 392 392 save : function(id) { … … 454 454 * @since 2.7.0 455 455 * 456 * @return s{boolean} Always returns false.456 * @return {boolean} Always returns false. 457 457 */ 458 458 revert : function(){ … … 498 498 * @since 2.7.0 499 499 * 500 * @param 501 * @return s{string} The post id extracted from the table row in the object.500 * @param {Object} o DOM row object to get the id for. 501 * @return {string} The post id extracted from the table row in the object. 502 502 */ 503 503 getId : function(o) { -
trunk/src/js/_enqueues/admin/inline-edit-tax.js
r43577 r46800 30 30 * @this inlineEditTax 31 31 * @memberof inlineEditTax 32 * @return s{void}32 * @return {void} 33 33 */ 34 34 init : function() { … … 97 97 * @param {HTMLElement} el An element within the table row or the table row 98 98 * itself that we want to quick edit. 99 * @return s{void}99 * @return {void} 100 100 */ 101 101 toggle : function(el) { … … 116 116 * element within the table row or the 117 117 * table row itself. 118 * @return s{boolean} Always returns false.118 * @return {boolean} Always returns false. 119 119 */ 120 120 edit : function(id) { … … 163 163 * element within the table row or the 164 164 * table row itself. 165 * @return s{boolean} Always returns false.165 * @return {boolean} Always returns false. 166 166 */ 167 167 save : function(id) { … … 256 256 * @this inlineEditTax 257 257 * @memberof inlineEditTax 258 * @return s{void}258 * @return {void} 259 259 */ 260 260 revert : function() { … … 281 281 * 282 282 * @param {HTMLElement} o An element within the table row or the table row itself. 283 * @return s{string} The ID of the term based on the element.283 * @return {string} The ID of the term based on the element. 284 284 */ 285 285 getId : function(o) { -
trunk/src/js/_enqueues/admin/link.js
r43352 r46800 123 123 * 124 124 * @param {Event} event The event object. 125 * @return s{boolean} Always returns false to prevent regular link126 * 125 * @return {boolean} Always returns false to prevent regular link 126 * functionality. 127 127 */ 128 128 $('#category-add-toggle').click( function() { -
trunk/src/js/_enqueues/admin/media-upload.js
r43577 r46800 23 23 * 24 24 * @param {string} html The HTML to be sent to the editor. 25 * @return s{void|boolean} Returns false when both TinyMCE and QTags instances26 * 27 * 25 * @return {void|boolean} Returns false when both TinyMCE and QTags instances 26 * are unavailable. This means that the HTML was not 27 * sent to the editor. 28 28 */ 29 29 window.send_to_editor = function( html ) { … … 72 72 * @global 73 73 * 74 * @return s{Object[]} Array containing jQuery objects for all the found75 * 74 * @return {Object[]} Array containing jQuery objects for all the found 75 * ThickBox anchors. 76 76 */ 77 77 window.tb_position = function() { -
trunk/src/js/_enqueues/admin/media.js
r43577 r46800 27 27 * @param {string} af_val The value of the affected post element. 28 28 * 29 * @return s{boolean} Always returns false.29 * @return {boolean} Always returns false. 30 30 */ 31 31 open: function( af_name, af_val ) { … … 66 66 * @memberOf findPosts 67 67 * 68 * @return s{void}68 * @return {void} 69 69 */ 70 70 close: function() { … … 82 82 * @memberOf findPosts 83 83 * 84 * @return s{void}84 * @return {void} 85 85 */ 86 86 overlay: function() { … … 101 101 * @memberOf findPosts 102 102 * 103 * @return s{void}103 * @return {void} 104 104 */ 105 105 send: function() { … … 139 139 * various form elements. 140 140 * 141 * @return s{void}141 * @return {void} 142 142 */ 143 143 $( document ).ready( function() { … … 199 199 * Enables clicking on the entire table row. 200 200 * 201 * @return s{void}201 * @return {void} 202 202 */ 203 203 $( '.find-box-inside' ).on( 'click', 'tr', function() { -
trunk/src/js/_enqueues/admin/post.js
r45979 r46800 36 36 * @param {int} total Total number of comments for this post. 37 37 * @param {int} num Optional. Number of comments to fetch, defaults to 20. 38 * @return s{boolean} Always returns false.38 * @return {boolean} Always returns false. 39 39 */ 40 40 get : function(total, num) { … … 600 600 * @param {Object} s Taxonomy object which will be added. 601 601 * 602 * @return s{Object}602 * @return {Object} 603 603 */ 604 604 catAddBefore = function( s ) { … … 621 621 * @param {Object} s Taxonomy data. 622 622 * 623 * @return s void623 * @return {void} 624 624 */ 625 625 catAddAfter = function( r, s ) { … … 667 667 * @param {Object} s Request object. 668 668 * 669 * @return s{Object} Data modified with post_ID attached.669 * @return {Object} Data modified with post_ID attached. 670 670 */ 671 671 addBefore: function( s ) { … … 696 696 * @ignore 697 697 * 698 * @return s void698 * @return {void} 699 699 */ 700 700 updateVisibility = function() { … … 720 720 * @ignore 721 721 * 722 * @return s{boolean} False when an invalid timestamp has been selected, otherwise True.722 * @return {boolean} False when an invalid timestamp has been selected, otherwise True. 723 723 */ 724 724 updateText = function() { … … 942 942 * @global 943 943 * 944 * @return s void944 * @return {void} 945 945 */ 946 946 function editPermalink() { … … 1052 1052 * @global 1053 1053 * 1054 * @return s void1054 * @return {void} 1055 1055 */ 1056 1056 window.wptitlehint = function( id ) { -
trunk/src/js/_enqueues/admin/postbox.js
r43577 r46800 36 36 * @fires postboxes#postbox-toggled 37 37 * 38 * @return s{void}38 * @return {void} 39 39 */ 40 40 handle_click : function () { … … 97 97 * @param {Function} args.pbshow A callback that is called when a postbox opens. 98 98 * @param {Function} args.pbhide A callback that is called when a postbox closes. 99 * @return s{void}99 * @return {void} 100 100 */ 101 101 add_postbox_toggles : function (page, args) { … … 122 122 * @since 3.2.0 123 123 * 124 * @return s{void}124 * @return {void} 125 125 */ 126 126 $( '.postbox a.dismiss' ).on( 'click.postboxes', function( e ) { … … 141 141 * @fires postboxes#postbox-toggled 142 142 * 143 * @return s{void}143 * @return {void} 144 144 */ 145 145 $('.hide-postbox-tog').bind('click.postboxes', function() { … … 175 175 * @since 2.8.0 176 176 * 177 * @return s{void}177 * @return {void} 178 178 */ 179 179 $('.columns-prefs input[type="radio"]').bind('click.postboxes', function(){ … … 199 199 * closes. 200 200 * 201 * @return s{void}201 * @return {void} 202 202 */ 203 203 init : function(page, args) { … … 276 276 * 277 277 * @param {string} page The page we are currently on. 278 * @return s{void}278 * @return {void} 279 279 */ 280 280 save_state : function(page) { … … 307 307 * 308 308 * @param {string} page The page we are currently on. 309 * @return s{void}309 * @return {void} 310 310 */ 311 311 save_order : function(page) { … … 337 337 * @access private 338 338 * 339 * @return s{void}339 * @return {void} 340 340 */ 341 341 _mark_area : function() { … … 371 371 * 372 372 * @param {number} n The amount of columns to divide the post edit page in. 373 * @return s{void}373 * @return {void} 374 374 */ 375 375 _pb_edit : function(n) { … … 399 399 * @access private 400 400 * 401 * @return s{void}401 * @return {void} 402 402 */ 403 403 _pb_change : function() { -
trunk/src/js/_enqueues/admin/tags-suggest.js
r45227 r46800 32 32 * 33 33 * @param {object} options Options that are passed to UI Autocomplete. Can be used to override the default settings. 34 * @return s{object} jQuery instance.34 * @return {object} jQuery instance. 35 35 */ 36 36 $.fn.wpTagsSuggest = function( options ) { -
trunk/src/js/_enqueues/admin/tags.js
r45683 r46800 21 21 * @since 2.8.0 22 22 * 23 * @return s booleanAlways returns false to cancel the default event handling.23 * @return {boolean} Always returns false to cancel the default event handling. 24 24 */ 25 25 $( '#the-list' ).on( 'click', '.delete-tag', function() { … … 38 38 * @param {string} r The response from the server. 39 39 * 40 * @return s{void}40 * @return {void} 41 41 */ 42 42 $.post(ajaxurl, data, function(r){ … … 76 76 * @since 4.8.0 77 77 * 78 * @return s{void}78 * @return {void} 79 79 */ 80 80 $( '#edittag' ).on( 'click', '.delete', function( e ) { … … 97 97 * @since 2.8.0 98 98 * 99 * @return s booleanAlways returns false to cancel the default event handling.99 * @return {boolean} Always returns false to cancel the default event handling. 100 100 */ 101 101 $('#submit').click(function(){ … … 118 118 * @param {string} r The response from the server. 119 119 * 120 * @return s{void}120 * @return {void} 121 121 */ 122 122 $.post(ajaxurl, $('#addtag').serialize(), function(r){ -
trunk/src/js/_enqueues/lib/color-picker.js
r46799 r46800 40 40 * @access private 41 41 * 42 * @return s{void}42 * @return {void} 43 43 */ 44 44 _createHueOnly: function() { … … 66 66 * @param {HTMLElement} ui The HTMLElement containing the color picker. 67 67 * 68 * @return s{void}68 * @return {void} 69 69 */ 70 70 change: function( event, ui ) { … … 84 84 * @access private 85 85 * 86 * @return s{void}86 * @return {void} 87 87 */ 88 88 _create: function() { … … 187 187 * @param {HTMLElement} ui The HTMLElement containing the color picker. 188 188 * 189 * @return s{void}189 * @return {void} 190 190 */ 191 191 change: function( event, ui ) { … … 213 213 * @access private 214 214 * 215 * @return s{void}215 * @return {void} 216 216 */ 217 217 _addListeners: function() { … … 225 225 * @param {Event} event The event that's being called. 226 226 * 227 * @retur s{void}227 * @return {void} 228 228 */ 229 229 self.wrap.on( 'click.wpcolorpicker', function( event ) { … … 234 234 * Open or close the color picker depending on the class. 235 235 * 236 * @since 3.5 236 * @since 3.5.0 237 237 */ 238 238 self.toggler.click( function(){ … … 252 252 * @param {Event} event The event that's being called. 253 253 * 254 * @return s{void}254 * @return {void} 255 255 */ 256 256 self.element.change( function( event ) { … … 274 274 * @param {Event} event The event that's being called. 275 275 * 276 * @return s{void}276 * @return {void} 277 277 */ 278 278 self.button.click( function( event ) { … … 294 294 * @since 3.5.0 295 295 * 296 * @return s{void}296 * @return {void} 297 297 */ 298 298 open: function() { … … 310 310 * @since 3.5.0 311 311 * 312 * @return s{void}312 * @return {void} 313 313 */ 314 314 close: function() { … … 328 328 * @since 3.5.0 329 329 * 330 * @return s{string} The element's color.330 * @return {string} The element's color. 331 331 */ 332 332 color: function( newColor ) { … … 344 344 * @since 3.5.0 345 345 * 346 * @return s{boolean|string} The element's color.346 * @return {boolean|string} The element's color. 347 347 */ 348 348 defaultColor: function( newDefaultColor ) { -
trunk/src/js/_enqueues/lib/image-edit.js
r46355 r46800 77 77 * instead of true or false. 78 78 * 79 * @return s{void}79 * @return {void} 80 80 */ 81 81 setDisabled : function( el, s ) { … … 101 101 * @param {number} postid The post id. 102 102 * 103 * @return s{void}103 * @return {void} 104 104 */ 105 105 init : function(postid) { … … 145 145 * @param {number} toggle Is 0 or 1, fades the icon in then 1 and out when 0. 146 146 * 147 * @return s{void}147 * @return {void} 148 148 */ 149 149 toggleEditor : function(postid, toggle) { … … 165 165 * @param {HTMLElement} el The element to create the help window in. 166 166 * 167 * @return s{boolean} Always returns false.167 * @return {boolean} Always returns false. 168 168 */ 169 169 toggleHelp : function(el) { … … 187 187 * @param {number} postid The post id. 188 188 * 189 * @return s{string} The value from the imagedit-save-target input field when available,190 * 189 * @return {string} The value from the imagedit-save-target input field when available, 190 * or 'full' when not available. 191 191 */ 192 192 getTarget : function(postid) { … … 207 207 * @param {jQuery} el Element. 208 208 * 209 * @return s{void}209 * @return {void} 210 210 */ 211 211 scaleChanged : function( postid, x, el ) { … … 240 240 * @param {number} postid The post id. 241 241 * 242 * @return s{string} The aspect ratio.242 * @return {string} The aspect ratio. 243 243 */ 244 244 getSelRatio : function(postid) { … … 268 268 * @param {number} setSize 0 or 1, when 1 the image resets to its original size. 269 269 * 270 * @return s{string} JSON string containing the history or an empty string if no history exists.270 * @return {string} JSON string containing the history or an empty string if no history exists. 271 271 */ 272 272 filterHistory : function(postid, setSize) { … … 334 334 * @param {function} callback Function to execute when the image is loaded. 335 335 * 336 * @return s{void}336 * @return {void} 337 337 */ 338 338 refreshEditor : function(postid, nonce, callback) { … … 408 408 * The possible actions are: "scale" and "restore". 409 409 * 410 * @return s{boolean|void} Executes a post request that refreshes the page411 * 412 * 413 * 410 * @return {boolean|void} Executes a post request that refreshes the page 411 * when the action is performed. 412 * Returns false if a invalid action is given, 413 * or when the action cannot be performed. 414 414 */ 415 415 action : function(postid, nonce, action) { … … 473 473 * @param {string} nonce The nonce to verify the request. 474 474 * 475 * @return s{boolean|void} If the actions are successfully saved a response message is shown.476 * 477 * 475 * @return {boolean|void} If the actions are successfully saved a response message is shown. 476 * Returns false if there is no image editing history, 477 * thus there are not edit-actions performed on the image. 478 478 */ 479 479 save : function(postid, nonce) { … … 539 539 * @param {object} view The image editor view to be used for the editing. 540 540 * 541 * @return s{void|promise} Either returns void if the button was already activated542 * 541 * @return {void|promise} Either returns void if the button was already activated 542 * or returns an instance of the image editor, wrapped in a promise. 543 543 */ 544 544 open : function( postid, nonce, view ) { … … 594 594 * @param {number} postid The post id. 595 595 * 596 * @return s{void}596 * @return {void} 597 597 */ 598 598 imgLoaded : function(postid) { … … 622 622 * @param {HTMLElement} parent The preview image container. 623 623 * 624 * @return s{void}624 * @return {void} 625 625 */ 626 626 initCrop : function(postid, image, parent) { … … 654 654 * Binds mouse down event to the cropping container. 655 655 * 656 * @return s{void}656 * @return {void} 657 657 */ 658 658 parent.children().on( 'mousedown, touchstart', function(e){ … … 676 676 * @ignore 677 677 * 678 * @return s{void}678 * @return {void} 679 679 */ 680 680 onSelectStart: function() { … … 689 689 * @param {object} c The selection. 690 690 * 691 * @return s{object}691 * @return {object} 692 692 */ 693 693 onSelectEnd: function(img, c) { … … 703 703 * @param {object} c The selection. 704 704 * 705 * @return s{void}705 * @return {void} 706 706 */ 707 707 onSelectChange: function(img, c) { … … 722 722 * @param {object} c The selection. 723 723 * 724 * @return s{boolean}724 * @return {boolean} 725 725 */ 726 726 setCropSelection : function(postid, c) { … … 753 753 * @param {bool} warn Warning message. 754 754 * 755 * @return s{void|bool} Returns false if there is a warning.755 * @return {void|bool} Returns false if there is a warning. 756 756 */ 757 757 close : function(postid, warn) { … … 793 793 * @param {number} postid The post id. 794 794 * 795 * @return s{boolean} Returns true if the history is not saved.795 * @return {boolean} Returns true if the history is not saved. 796 796 */ 797 797 notsaved : function(postid) { … … 819 819 * @param {string} nonce The nonce. 820 820 * 821 * @return s{void}821 * @return {void} 822 822 */ 823 823 addStep : function(op, postid, nonce) { … … 853 853 * @param {object} t The target element. 854 854 * 855 * @return s{boolean}855 * @return {boolean} 856 856 */ 857 857 rotate : function(angle, postid, nonce, t) { … … 874 874 * @param {object} t The target element. 875 875 * 876 * @return s{boolean}876 * @return {boolean} 877 877 */ 878 878 flip : function (axis, postid, nonce, t) { … … 894 894 * @param {object} t The target object. 895 895 * 896 * @return s{void|boolean} Returns false if the crop button is disabled.896 * @return {void|boolean} Returns false if the crop button is disabled. 897 897 */ 898 898 crop : function (postid, nonce, t) { … … 922 922 * @param {string} nonce The nonce. 923 923 * 924 * @return s{void|false} Returns false if the undo button is disabled.924 * @return {void|false} Returns false if the undo button is disabled. 925 925 */ 926 926 undo : function (postid, nonce) { … … 955 955 * @param {string} nonce The nonce. 956 956 * 957 * @return s{void}957 * @return {void} 958 958 */ 959 959 redo : function(postid, nonce) { … … 985 985 * @param {jQuery} el The element containing the values. 986 986 * 987 * @return s{void|boolean} Returns false when the x or y value is lower than 1,988 * 989 * 987 * @return {void|boolean} Returns false when the x or y value is lower than 1, 988 * void when the value is not numeric or when the operation 989 * is successful. 990 990 */ 991 991 setNumSelection : function( postid, el ) { … … 1041 1041 * @param {number} num The number. 1042 1042 * 1043 * @return s{number} The number rounded to a whole number.1043 * @return {number} The number rounded to a whole number. 1044 1044 */ 1045 1045 round : function(num) { … … 1072 1072 * @param {jQuery} el The element containing the values. 1073 1073 * 1074 * @return s{void}1074 * @return {void} 1075 1075 */ 1076 1076 setRatioSelection : function(postid, n, el) { … … 1114 1114 * @param {jQuery} el The html element. 1115 1115 * 1116 * @return s{void|boolean} Returns false if the value is not numeric,1117 * 1116 * @return {void|boolean} Returns false if the value is not numeric, 1117 * void when it is. 1118 1118 */ 1119 1119 validateNumeric: function( el ) { -
trunk/src/js/_enqueues/lib/lists.js
r43347 r46800 114 114 * @param {string} action The type of action to perform: 'add', 'delete', or 'dim'. 115 115 * @param {string} backgroundColor Background color of the list's DOM element. 116 * @return s{boolean} Whether to proceed with the action or not.116 * @return {boolean} Whether to proceed with the action or not. 117 117 */ 118 118 confirm: null, … … 125 125 * @callback wpList~addBefore 126 126 * @param {object} settings Settings for the Ajax request. 127 * @return s{object|boolean} Settings for the Ajax request or false to abort.127 * @return {object|boolean} Settings for the Ajax request or false to abort. 128 128 */ 129 129 addBefore: null, … … 150 150 * @param {object} settings Settings for the Ajax request. 151 151 * @param {HTMLElement} list The list DOM element. 152 * @return s{object|boolean} Settings for the Ajax request or false to abort.152 * @return {object|boolean} Settings for the Ajax request or false to abort. 153 153 */ 154 154 delBefore: null, … … 174 174 * @callback wpList~dimBefore 175 175 * @param {object} settings Settings for the Ajax request. 176 * @return s{object|boolean} Settings for the Ajax request or false to abort.176 * @return {object|boolean} Settings for the Ajax request or false to abort. 177 177 */ 178 178 dimBefore: null, … … 204 204 * @param {jQuery} element Element that triggered the request. 205 205 * @param {object} settings Settings for the Ajax request. 206 * @return s{string|number} Nonce206 * @return {string|number} Nonce 207 207 */ 208 208 nonce: function( element, settings ) { … … 238 238 * @param {HTMLElement} element The DOM element. 239 239 * @param {string} type The type of data to look for: 'list', 'add', 'delete', or 'dim'. 240 * @return s{Array} Extracted list item data.240 * @return {Array} Extracted list item data. 241 241 */ 242 242 parseData: function( element, type ) { … … 261 261 * @param {object} settings Settings for this list. 262 262 * @param {string} action The type of action to perform: 'add', 'delete', or 'dim'. 263 * @return s{object|boolean} Settings if confirmed, false if not.263 * @return {object|boolean} Settings if confirmed, false if not. 264 264 */ 265 265 pre: function( list, settings, action ) { … … 299 299 * @param {HTMLElement} element The DOM element. 300 300 * @param {object} settings Settings for this list. 301 * @return s{boolean} Whether the item was added.301 * @return {boolean} Whether the item was added. 302 302 */ 303 303 ajaxAdd: function( element, settings ) { … … 401 401 * @param {HTMLElement} element A DOM element containing item data. 402 402 * @param {object} settings Settings for this list. 403 * @return s{boolean} Whether the item was deleted.403 * @return {boolean} Whether the item was deleted. 404 404 */ 405 405 ajaxDel: function( element, settings ) { … … 488 488 * @param {HTMLElement} element A DOM element containing item data. 489 489 * @param {object} settings Settings for this list. 490 * @return s{boolean} Whether the item was dim'ed.490 * @return {boolean} Whether the item was dim'ed. 491 491 */ 492 492 ajaxDim: function( element, settings ) { … … 612 612 * 613 613 * @param {jQuery|string} element Element to check. 614 * @return s{string} Background color value in HEX. Default: '#ffffff'.614 * @return {string} Background color value in HEX. Default: '#ffffff'. 615 615 */ 616 616 getColor: function( element ) { … … 623 623 * @param {HTMLElement} element A DOM element containing item data. 624 624 * @param {object} settings Settings for this list. 625 * @return s{boolean} Whether the item was added.625 * @return {boolean} Whether the item was added. 626 626 */ 627 627 add: function( element, settings ) { … … 836 836 * @param {wpList~dimBefore} settings.dimBefore Callback that's run before an item gets dim'd. Default: null. 837 837 * @param {wpList~dimAfter} settings.dimAfter Callback that's run after an item got dim'd. Default: null. 838 * @return s{$.fn} wpList API function.838 * @return {$.fn} wpList API function. 839 839 */ 840 840 $.fn.wpList = function( settings ) { -
trunk/src/js/_enqueues/vendor/mediaelement/wp-mediaelement.js
r43309 r46800 17 17 * @since 4.4.0 18 18 * 19 * @return s{void}19 * @return {void} 20 20 */ 21 21 function initialize() { … … 55 55 * @param {object} media The wrapper that mimics all the native events/properties/methods for all renderers. 56 56 * @param {object} node The original HTML video, audio, or iframe tag where the media was loaded. 57 * @return s{string}57 * @return {string} 58 58 */ 59 59 settings.customError = function ( media, node ) { -
trunk/src/js/_enqueues/vendor/mediaelement/wp-playlist.js
r43309 r46800 178 178 * 179 179 * @since 4.9.3 180 * @return s{void}180 * @return {void} 181 181 */ 182 182 function initialize() { -
trunk/src/js/_enqueues/wp/a11y.js
r45979 r46800 22 22 * @param {String} [ariaLive] The politeness level for aria-live. Possible values: 23 23 * polite or assertive. Default polite. 24 * @return s{void}24 * @return {void} 25 25 */ 26 26 function speak( message, ariaLive ) { -
trunk/src/js/_enqueues/wp/api.js
r46586 r46800 836 836 * @param {Backbone.Model} model. 837 837 * @param {{beforeSend}, *} options. 838 * @return s{*}.838 * @return {*}. 839 839 */ 840 840 sync: function( method, model, options ) { … … 989 989 * @param {Backbone.Model} model. 990 990 * @param {{success}, *} options. 991 * @return s{*}.991 * @return {*}. 992 992 */ 993 993 sync: function( method, model, options ) { … … 1064 1064 * 1065 1065 * @param {data: {page}} options. 1066 * @return s{*}.1066 * @return {*}. 1067 1067 */ 1068 1068 more: function( options ) { … … 1090 1090 * Returns true if there are more pages of objects available. 1091 1091 * 1092 * @return s null|boolean.1092 * @return {null|boolean} 1093 1093 */ 1094 1094 hasMore: function() { -
trunk/src/js/_enqueues/wp/autosave.js
r43347 r46800 24 24 * @since 3.9.0 25 25 * 26 * @return s{Object}26 * @return {Object} 27 27 * {{ 28 28 * getPostData: getPostData, … … 47 47 * @param {string} type The type of autosave either local or remote. 48 48 * 49 * @return s{Object} Object containing the post data.49 * @return {Object} Object containing the post data. 50 50 */ 51 51 function getPostData( type ) { … … 111 111 * @param {Object} postData The object containing the post data. 112 112 * 113 * @return s{string} A concatenated string with title, content and excerpt.113 * @return {string} A concatenated string with title, content and excerpt. 114 114 */ 115 115 function getCompareString( postData ) { … … 126 126 * @since 3.9.0 127 127 * 128 * @return s{void}128 * @return {void} 129 129 */ 130 130 function disableButtons() { … … 140 140 * @since 3.9.0 141 141 * 142 * @return s{void}142 * @return {void} 143 143 */ 144 144 function enableButtons() { … … 151 151 * @since 4.6.0 152 152 * 153 * @return s{boolean|*} Returns either false if the editor is undefined,154 * 153 * @return {boolean|*} Returns either false if the editor is undefined, 154 * or the instance of the content editor. 155 155 */ 156 156 function getEditor() { … … 163 163 * @since 3.9.0 164 164 * 165 * @return s{165 * @return { 166 166 * { 167 167 * hasStorage: *, … … 184 184 * @since 3.9.0 185 185 * 186 * @return s{boolean} True if the sessionStorage is supported and enabled.186 * @return {boolean} True if the sessionStorage is supported and enabled. 187 187 */ 188 188 function checkStorage() { … … 205 205 * @since 3.9.0 206 206 * 207 * @return s{boolean|Object} False if no sessionStorage in the browser or an Object208 * 207 * @return {boolean|Object} False if no sessionStorage in the browser or an Object 208 * containing all postData for this blog. 209 209 */ 210 210 function getStorage() { … … 230 230 * @since 3.9.0 231 231 * 232 * @return s{boolean} True if the data was saved successfully, false if it wasn't saved.232 * @return {boolean} True if the data was saved successfully, false if it wasn't saved. 233 233 */ 234 234 function setStorage( stored_obj ) { … … 249 249 * @since 3.9.0 250 250 * 251 * @return s{boolean|Object} False if no storage or no data or the postData as an Object.251 * @return {boolean|Object} False if no storage or no data or the postData as an Object. 252 252 */ 253 253 function getSavedPostData() { … … 270 270 * @param {Object|boolean|null} stored_data The post data to store or null/false/empty to delete the key. 271 271 * 272 * @return s{boolean} True if data is stored, false if data was removed.272 * @return {boolean} True if data is stored, false if data was removed. 273 273 */ 274 274 function setData( stored_data ) { … … 295 295 * @since 3.9.0 296 296 * 297 * @return s{void}297 * @return {void} 298 298 */ 299 299 function suspend() { … … 306 306 * @since 3.9.0 307 307 * 308 * @return s{void}308 * @return {void} 309 309 */ 310 310 function resume() { … … 322 322 * @param {Object} data The post data for saving, minimum 'post_title' and 'content'. 323 323 * 324 * @return s{boolean} Returns true when data has been saved, otherwise it returns false.324 * @return {boolean} Returns true when data has been saved, otherwise it returns false. 325 325 */ 326 326 function save( data ) { … … 371 371 * @since 3.9.0 372 372 * 373 * @return s{void}373 * @return {void} 374 374 */ 375 375 function run() { … … 428 428 * @param {string} str1 The first string. 429 429 * @param {string} str2 The second string. 430 * @return s{boolean} True if the strings are the same.430 * @return {boolean} True if the strings are the same. 431 431 */ 432 432 function compare( str1, str2 ) { … … 446 446 * @since 3.9.0 447 447 * 448 * @return s{void}448 * @return {void} 449 449 */ 450 450 function checkPost() { … … 514 514 * @param {Object} postData The object containing all post data. 515 515 * 516 * @return s{boolean} True if the post is restored.516 * @return {boolean} True if the post is restored. 517 517 */ 518 518 function restorePost( postData ) { … … 580 580 * @since 3.9.0 581 581 * 582 * @return s{Object} {582 * @return {Object} { 583 583 * { 584 584 * tempBlockSave: tempBlockSave, … … 601 601 * @since 3.9.0 602 602 * 603 * @return s{void}603 * @return {void} 604 604 */ 605 605 function tempBlockSave() { … … 617 617 * @since 3.9.0 618 618 * 619 * @return s{void}619 * @return {void} 620 620 */ 621 621 function suspend() { … … 628 628 * @since 3.9.0 629 629 * 630 * @return s{void}630 * @return {void} 631 631 */ 632 632 function resume() { … … 641 641 * @param {Object} data The post data. 642 642 * 643 * @return s{void}643 * @return {void} 644 644 */ 645 645 function response( data ) { … … 665 665 * @since 3.9.0 666 666 * 667 * @return s{void}667 * @return {void} 668 668 */ 669 669 function triggerSave() { … … 694 694 * @since 3.9.0 695 695 * 696 * @return s{Object} Returns the post data.696 * @return {Object} Returns the post data. 697 697 */ 698 698 function save() { … … 740 740 * @since 3.9.0 741 741 * 742 * @return s{void}742 * @return {void} 743 743 */ 744 744 function _schedule() { … … 751 751 * @since 3.9.0 752 752 * 753 * @return s{void}753 * @return {void} 754 754 */ 755 755 $document.on( 'heartbeat-send.autosave', function( event, data ) { … … 766 766 * @since 3.9.0 767 767 * 768 * @return s{void}768 * @return {void} 769 769 */ 770 770 }).on( 'heartbeat-tick.autosave', function( event, data ) { … … 777 777 * @since 3.9.0 778 778 * 779 * @return s{void}779 * @return {void} 780 780 */ 781 781 }).on( 'heartbeat-connection-lost.autosave', function( event, error, status ) { … … 798 798 * @since 3.9.0 799 799 * 800 * @return s{void}800 * @return {void} 801 801 */ 802 802 }).on( 'heartbeat-connection-restored.autosave', function() { … … 826 826 * @since 3.9.0 827 827 * 828 * @return s{void}828 * @return {void} 829 829 */ 830 830 $document.on( 'tinymce-editor-init.autosave', function( event, editor ) { -
trunk/src/js/_enqueues/wp/code-editor.js
r46586 r46800 45 45 * @param {Function} settings.onUpdateErrorNotice - Callback to update error notice. 46 46 * 47 * @return s{void}47 * @return {void} 48 48 */ 49 49 function configureLinting( editor, settings ) { // eslint-disable-line complexity … … 53 53 * Call the onUpdateErrorNotice if there are new errors to show. 54 54 * 55 * @return s{void}55 * @return {void} 56 56 */ 57 57 function updateErrorNotice() { … … 65 65 * Get lint options. 66 66 * 67 * @return s{object} Lint options.67 * @return {object} Lint options. 68 68 */ 69 69 function getLintOptions() { // eslint-disable-line complexity … … 215 215 * @param {Function} settings.onTabPrevious - Callback to handle tabbing to the previous tabbable element. 216 216 * 217 * @return s{void}217 * @return {void} 218 218 */ 219 219 function configureTabbing( codemirror, settings ) { … … 274 274 * @param {object} [settings.jshint] - Rules for JSHint. 275 275 * 276 * @return s{CodeEditorInstance} Instance.276 * @return {CodeEditorInstance} Instance. 277 277 */ 278 278 wp.codeEditor.initialize = function initialize( textarea, settings ) { -
trunk/src/js/_enqueues/wp/customize/base.js
r43347 r46800 483 483 * when( id1, id2, id3, function( value1, value2, value3 ) {} ); 484 484 * 485 * @return s$.Deferred.promise();485 * @return $.Deferred.promise(); 486 486 */ 487 487 when: function() { … … 877 877 * @since 4.9.0 878 878 * 879 * @return s{jQuery} Notification container element.879 * @return {jQuery} Notification container element. 880 880 */ 881 881 render: function() { … … 943 943 * 944 944 * @param {string} queryString Query string. 945 * @return s{object} Parsed query string.945 * @return {object} Parsed query string. 946 946 */ 947 947 api.utils.parseQueryString = function parseQueryString( queryString ) { -
trunk/src/js/_enqueues/wp/customize/controls.js
r46799 r46800 56 56 * 57 57 * @param {jQuery.Event} event - Event. 58 * @return s{void}58 * @return {void} 59 59 */ 60 60 handleEscape: function( event ) { … … 99 99 * @param {boolean} [options.alt] - Whether alternative style should be used when rendering notifications. 100 100 * 101 * @return s{void}101 * @return {void} 102 102 */ 103 103 initialize: function( options ) { … … 138 138 * @param {string|wp.customize.Notification} notification - Notification object to add. Alternatively code may be supplied, and in that case the second notificationObject argument must be supplied. 139 139 * @param {wp.customize.Notification} [notificationObject] - Notification to add when first argument is the code string. 140 * @return s{wp.customize.Notification} Added notification (or existing instance if it was already added).140 * @return {wp.customize.Notification} Added notification (or existing instance if it was already added). 141 141 */ 142 142 add: function( notification, notificationObject ) { … … 212 212 * 213 213 * @since 4.9.0 214 * @return s{void}214 * @return {void} 215 215 */ 216 216 render: function() { … … 305 305 * 306 306 * @param {jQuery.Event} event - Event. 307 * @return s{void}307 * @return {void} 308 308 */ 309 309 constrainFocus: function constrainFocus( event ) { … … 399 399 * @access public 400 400 * 401 * @return s{void}401 * @return {void} 402 402 */ 403 403 preview: function() { … … 420 420 * 421 421 * @since 4.6.0 422 * @return s{wp.customize.Control[]} Controls associated with setting.422 * @return {wp.customize.Control[]} Controls associated with setting. 423 423 */ 424 424 findControls: function() { … … 498 498 * @param {object} [options] Options. 499 499 * @param {boolean} [options.unsaved=false] Whether only values not saved yet into a changeset will be returned (differential changes). 500 * @return s{object} Dirty setting values.500 * @return {object} Dirty setting values. 501 501 */ 502 502 api.dirtyValues = function dirtyValues( options ) { … … 536 536 * @param {string} [args.title] - Title to update in the changeset. Optional. 537 537 * @param {string} [args.date] - Date to update in the changeset. Optional. 538 * @return s{jQuery.Promise} Promise resolving with the response data.538 * @return {jQuery.Promise} Promise resolving with the response data. 539 539 */ 540 540 api.requestChangesetUpdate = function requestChangesetUpdate( changes, args ) { … … 736 736 * @param {(wp.customize.Panel|wp.customize.Section|wp.customize.Control)} a 737 737 * @param {(wp.customize.Panel|wp.customize.Section|wp.customize.Control)} b 738 * @return s{Number}738 * @return {Number} 739 739 */ 740 740 api.utils.prioritySort = function ( a, b ) { … … 754 754 * 755 755 * @param {jQuery.Event} event 756 * @return s{boolean}756 * @return {boolean} 757 757 */ 758 758 api.utils.isKeydownButNotEnterEvent = function ( event ) { … … 769 769 * @param {Array|jQuery} listA 770 770 * @param {Array|jQuery} listB 771 * @return s{boolean}771 * @return {boolean} 772 772 */ 773 773 api.utils.areElementListsEqual = function ( listA, listB ) { … … 803 803 * containing auxiliary UI, such as the Publish button augmented with a 804 804 * Settings button. 805 * @return s{Function} An idempotent function that cancels the reminder.805 * @return {Function} An idempotent function that cancels the reminder. 806 806 */ 807 807 api.utils.highlightButton = function highlightButton( button, options ) { … … 850 850 * @since 4.9.0 851 851 * 852 * @return s{int} Current timestamp.852 * @return {int} Current timestamp. 853 853 */ 854 854 api.utils.getCurrentTimestamp = function getCurrentTimestamp() { … … 894 894 * @ignore 895 895 * 896 * @return s{string|null} Normalized `transitionend` event name or null if CSS transitions are not supported.896 * @return {string|null} Normalized `transitionend` event name or null if CSS transitions are not supported. 897 897 */ 898 898 normalizedTransitionendEventName = (function () { … … 1015 1015 * 1016 1016 * @since 4.9.0 1017 * @return s{jQuery} Notification container element.1017 * @return {jQuery} Notification container element. 1018 1018 */ 1019 1019 getNotificationsContainerElement: function() { … … 1026 1026 * 1027 1027 * @since 4.9.0 1028 * @return s{void}1028 * @return {void} 1029 1029 */ 1030 1030 setupNotifications: function() { … … 1057 1057 * @param {String} parentType 1058 1058 * @param {String} childType 1059 * @return s{Array}1059 * @return {Array} 1060 1060 */ 1061 1061 _children: function ( parentType, childType ) { … … 1155 1155 * @param {Boolean} active 1156 1156 * @param {Object} [params] 1157 * @return s{Boolean} False if state already applied.1157 * @return {Boolean} False if state already applied. 1158 1158 */ 1159 1159 _toggleActive: function ( active, params ) { … … 1174 1174 /** 1175 1175 * @param {Object} [params] 1176 * @return s{Boolean} False if already active.1176 * @return {Boolean} False if already active. 1177 1177 */ 1178 1178 activate: function ( params ) { … … 1182 1182 /** 1183 1183 * @param {Object} [params] 1184 * @return s{Boolean} False if already inactive.1184 * @return {Boolean} False if already inactive. 1185 1185 */ 1186 1186 deactivate: function ( params ) { … … 1202 1202 * @param {Object} [params] - Object containing options for expand/collapse. 1203 1203 * @param {Function} [params.completeCallback] - Function to call when expansion/collapse is complete. 1204 * @return s{Boolean} False if state already applied or active state is false.1204 * @return {Boolean} False if state already applied or active state is false. 1205 1205 */ 1206 1206 _toggleExpanded: function( expanded, params ) { … … 1239 1239 /** 1240 1240 * @param {Object} [params] 1241 * @return s{Boolean} False if already expanded or if inactive.1241 * @return {Boolean} False if already expanded or if inactive. 1242 1242 */ 1243 1243 expand: function ( params ) { … … 1247 1247 /** 1248 1248 * @param {Object} [params] 1249 * @return s{Boolean} False if already collapsed.1249 * @return {Boolean} False if already collapsed. 1250 1250 */ 1251 1251 collapse: function ( params ) { … … 1260 1260 * 1261 1261 * @param {function} completeCallback Function to be called after transition is completed. 1262 * @return s{void}1262 * @return {void} 1263 1263 */ 1264 1264 _animateChangeExpanded: function( completeCallback ) { … … 1363 1363 * @access public 1364 1364 * 1365 * @return s{jQuery} Detached content element.1365 * @return {jQuery} Detached content element. 1366 1366 */ 1367 1367 getContent: function() { … … 1544 1544 * @since 4.1.0 1545 1545 * 1546 * @return s{Boolean}1546 * @return {Boolean} 1547 1547 */ 1548 1548 isContextuallyActive: function () { … … 1563 1563 * @since 4.1.0 1564 1564 * 1565 * @return s{Array}1565 * @return {Array} 1566 1566 */ 1567 1567 controls: function () { … … 1697 1697 * @param {string} id - ID. 1698 1698 * @param {object} options - Options. 1699 * @return s{void}1699 * @return {void} 1700 1700 */ 1701 1701 initialize: function( id, options ) { … … 1746 1746 * @since 4.2.0 1747 1747 * 1748 * @return s{void}1748 * @return {void} 1749 1749 */ 1750 1750 ready: function() { … … 1798 1798 * @since 4.2.0 1799 1799 * 1800 * @return s{Boolean}1800 * @return {Boolean} 1801 1801 */ 1802 1802 isContextuallyActive: function () { … … 1809 1809 * @since 4.2.0 1810 1810 * 1811 * @return s{void}1811 * @return {void} 1812 1812 */ 1813 1813 attachEvents: function () { … … 1954 1954 * @param {Boolean} args.unchanged 1955 1955 * @param {Function} args.completeCallback 1956 * @return s{void}1956 * @return {void} 1957 1957 */ 1958 1958 onChangeExpanded: function ( expanded, args ) { … … 2044 2044 * @since 4.9.0 2045 2045 * 2046 * @return s{jQuery}2046 * @return {jQuery} 2047 2047 */ 2048 2048 getContent: function() { … … 2055 2055 * @since 4.9.0 2056 2056 * 2057 * @return s{void}2057 * @return {void} 2058 2058 */ 2059 2059 loadThemes: function() { … … 2166 2166 * @param {Array} themes - Array of theme data to create controls with. 2167 2167 * @param {integer} page - Page of results being loaded. 2168 * @return s{void}2168 * @return {void} 2169 2169 */ 2170 2170 loadControls: function( themes, page ) { … … 2195 2195 * 2196 2196 * @since 4.9.0 2197 * @return s{void}2197 * @return {void} 2198 2198 */ 2199 2199 loadMore: function() { … … 2217 2217 * 2218 2218 * @param {string} term - The raw search input value. 2219 * @return s{void}2219 * @return {void} 2220 2220 */ 2221 2221 filterSearch: function( term ) { … … 2261 2261 * 2262 2262 * @param {wp.customize.ThemesSection} section - The current theme section, passed through the debouncer. 2263 * @return s{void}2263 * @return {void} 2264 2264 */ 2265 2265 checkTerm: function( section ) { … … 2278 2278 * @since 4.9.0 2279 2279 * 2280 * @return s{void}2280 * @return {void} 2281 2281 */ 2282 2282 filtersChecked: function() { … … 2321 2321 * @param {string} newTerm - New term. 2322 2322 * @param {Array} newTags - New tags. 2323 * @return s{void}2323 * @return {void} 2324 2324 */ 2325 2325 initializeNewQuery: function( newTerm, newTags ) { … … 2354 2354 * @since 4.2.0 2355 2355 * 2356 * @return s{void}2356 * @return {void} 2357 2357 */ 2358 2358 renderScreenshots: function() { … … 2408 2408 * @since 4.9.0 2409 2409 * 2410 * @return s{int} Visible count.2410 * @return {int} Visible count. 2411 2411 */ 2412 2412 getVisibleCount: function() { … … 2419 2419 * @since 4.9.0 2420 2420 * 2421 * @return s{void}2421 * @return {void} 2422 2422 */ 2423 2423 updateCount: function( count ) { … … 2449 2449 * @since 4.2.0 2450 2450 * 2451 * @return s{void}2451 * @return {void} 2452 2452 */ 2453 2453 nextTheme: function () { … … 2465 2465 * @since 4.2.0 2466 2466 * 2467 * @return s{wp.customize.ThemeControl|boolean} Next theme.2467 * @return {wp.customize.ThemeControl|boolean} Next theme. 2468 2468 */ 2469 2469 getNextTheme: function () { … … 2487 2487 * 2488 2488 * @since 4.2.0 2489 * @return s{void}2489 * @return {void} 2490 2490 */ 2491 2491 previousTheme: function () { … … 2502 2502 * 2503 2503 * @since 4.2.0 2504 * @return s{wp.customize.ThemeControl|boolean} Previous theme.2504 * @return {wp.customize.ThemeControl|boolean} Previous theme. 2505 2505 */ 2506 2506 getPreviousTheme: function () { … … 2525 2525 * @since 4.2.0 2526 2526 * 2527 * @return s{void}2527 * @return {void} 2528 2528 */ 2529 2529 updateLimits: function () { … … 2544 2544 * @deprecated 2545 2545 * @param {string} themeId Theme ID. 2546 * @return s{jQuery.promise} Promise.2546 * @return {jQuery.promise} Promise. 2547 2547 */ 2548 2548 loadThemePreview: function( themeId ) { … … 2557 2557 * @param {object} theme - Theme. 2558 2558 * @param {Function} [callback] - Callback once the details have been shown. 2559 * @return s{void}2559 * @return {void} 2560 2560 */ 2561 2561 showDetails: function ( theme, callback ) { … … 2592 2592 * @since 4.2.0 2593 2593 * 2594 * @return s{void}2594 * @return {void} 2595 2595 */ 2596 2596 closeDetails: function () { … … 2607 2607 * 2608 2608 * @param {jQuery} el - Element to contain focus. 2609 * @return s{void}2609 * @return {void} 2610 2610 */ 2611 2611 containFocus: function( el ) { … … 2648 2648 * @since 4.9.0 2649 2649 * 2650 * @return s{void}2650 * @return {void} 2651 2651 */ 2652 2652 initialize: function() { … … 2871 2871 * @since 4.1.0 2872 2872 * 2873 * @return s{Array}2873 * @return {Array} 2874 2874 */ 2875 2875 sections: function () { … … 2882 2882 * @since 4.1.0 2883 2883 * 2884 * @return s{boolean} Whether contextually active.2884 * @return {boolean} Whether contextually active. 2885 2885 */ 2886 2886 isContextuallyActive: function () { … … 2905 2905 * @param {Boolean} args.unchanged 2906 2906 * @param {Function} args.completeCallback 2907 * @return s{void}2907 * @return {void} 2908 2908 */ 2909 2909 onChangeExpanded: function ( expanded, args ) { … … 3033 3033 * @param {string} id - The ID for the panel. 3034 3034 * @param {object} options - Options. 3035 * @return s{void}3035 * @return {void} 3036 3036 */ 3037 3037 initialize: function( id, options ) { … … 3047 3047 * 3048 3048 * @param {string} [slug] - Theme slug. 3049 * @return s{boolean} Whether the theme can be switched to.3049 * @return {boolean} Whether the theme can be switched to. 3050 3050 */ 3051 3051 canSwitchTheme: function canSwitchTheme( slug ) { … … 3060 3060 * 3061 3061 * @since 4.9.0 3062 * @return s{void}3062 * @return {void} 3063 3063 */ 3064 3064 attachEvents: function() { … … 3133 3133 * @param {Boolean} args.unchanged - Whether or not the state changed. 3134 3134 * @param {Function} args.completeCallback - Callback to execute when the animation completes. 3135 * @return s{void}3135 * @return {void} 3136 3136 */ 3137 3137 onChangeExpanded: function( expanded, args ) { … … 3185 3185 * 3186 3186 * @param {jQuery.Event} event - Event. 3187 * @return s{jQuery.promise} Promise.3187 * @return {jQuery.promise} Promise. 3188 3188 */ 3189 3189 installTheme: function( event ) { … … 3290 3290 * 3291 3291 * @param {string} themeId Theme ID. 3292 * @return s{jQuery.promise} Promise.3292 * @return {jQuery.promise} Promise. 3293 3293 */ 3294 3294 loadThemePreview: function( themeId ) { … … 3366 3366 * 3367 3367 * @param {jQuery.Event} event - Event. 3368 * @return s{void}3368 * @return {void} 3369 3369 */ 3370 3370 updateTheme: function( event ) { … … 3396 3396 * 3397 3397 * @param {jQuery.Event} event - Event. 3398 * @return s{void}3398 * @return {void} 3399 3399 */ 3400 3400 deleteTheme: function( event ) { … … 3493 3493 * @param {number} [options.instanceNumber] - Order in which this instance was created in relation to other instances. 3494 3494 * @param {object} [options.params] - Deprecated wrapper for the above properties. 3495 * @return s{void}3495 * @return {void} 3496 3496 */ 3497 3497 initialize: function( id, options ) { … … 3634 3634 * @access public 3635 3635 * 3636 * @return s{void}3636 * @return {void} 3637 3637 */ 3638 3638 linkElements: function () { … … 3709 3709 * Triggered when the control's markup has been injected into the DOM. 3710 3710 * 3711 * @return s{void}3711 * @return {void} 3712 3712 */ 3713 3713 ready: function() { … … 3740 3740 * 3741 3741 * @since 4.6.0 3742 * @return s{jQuery} Setting validation message element.3742 * @return {jQuery} Setting validation message element. 3743 3743 */ 3744 3744 getNotificationsContainerElement: function() { … … 3771 3771 * 3772 3772 * @since 4.9.0 3773 * @return s{void}3773 * @return {void} 3774 3774 */ 3775 3775 setupNotifications: function() { … … 4048 4048 * @since 4.7.0 4049 4049 * @access private 4050 * @return s{void}4050 * @return {void} 4051 4051 */ 4052 4052 addNewPage: function () { … … 4571 4571 * @param {wp.media.model.Attachment} attachment 4572 4572 * @param {wp.media.controller.Cropper} controller 4573 * @return s{Object} Options4573 * @return {Object} Options 4574 4574 */ 4575 4575 calculateImageSelectOptions: function( attachment, controller ) { … … 4854 4854 * @since 4.2.0 4855 4855 * 4856 * @return s{Object} Options4856 * @return {Object} Options 4857 4857 */ 4858 4858 getInitialHeaderImage: function() { … … 4887 4887 * @param {wp.media.model.Attachment} attachment 4888 4888 * @param {wp.media.controller.Cropper} controller 4889 * @return s{Object} Options4889 * @return {Object} Options 4890 4890 */ 4891 4891 calculateImageSelectOptions: function(attachment, controller) { … … 5156 5156 * @since 4.2.0 5157 5157 * @param {Array} terms - An array of terms to search for. 5158 * @return s{boolean} Whether a theme control was activated or not.5158 * @return {boolean} Whether a theme control was activated or not. 5159 5159 */ 5160 5160 filter: function( terms ) { … … 5208 5208 * @since 4.9.0 5209 5209 * 5210 * @return s{void}5210 * @return {void} 5211 5211 */ 5212 5212 rerenderAsInstalled: function( installed ) { … … 5239 5239 * @param {string} id - Unique identifier for the control instance. 5240 5240 * @param {object} options - Options hash for the control instance. 5241 * @return s{void}5241 * @return {void} 5242 5242 */ 5243 5243 initialize: function( id, options ) { … … 5274 5274 * 5275 5275 * @since 4.9.0 5276 * @return s{void}5276 * @return {void} 5277 5277 */ 5278 5278 ready: function() { … … 5306 5306 * 5307 5307 * @since 4.9.0 5308 * @return s{void}5308 * @return {void} 5309 5309 */ 5310 5310 initEditor: function() { … … 5357 5357 * @param {Object} [params] - Focus params. 5358 5358 * @param {Function} [params.completeCallback] - Function to call when expansion is complete. 5359 * @return s{void}5359 * @return {void} 5360 5360 */ 5361 5361 focus: function( params ) { … … 5378 5378 * @since 4.9.0 5379 5379 * @param {object} codeEditorSettings - Code editor settings. 5380 * @return s{void}5380 * @return {void} 5381 5381 */ 5382 5382 initSyntaxHighlightingEditor: function( codeEditorSettings ) { … … 5437 5437 * 5438 5438 * @since 4.9.0 5439 * @return s{void}5439 * @return {void} 5440 5440 */ 5441 5441 onTabNext: function onTabNext() { … … 5455 5455 * 5456 5456 * @since 4.9.0 5457 * @return s{void}5457 * @return {void} 5458 5458 */ 5459 5459 onTabPrevious: function onTabPrevious() { … … 5474 5474 * @since 4.9.0 5475 5475 * @param {Array} errorAnnotations - Error annotations. 5476 * @return s{void}5476 * @return {void} 5477 5477 */ 5478 5478 onUpdateErrorNotice: function onUpdateErrorNotice( errorAnnotations ) { … … 5497 5497 * 5498 5498 * @since 4.9.0 5499 * @return s{void}5499 * @return {void} 5500 5500 */ 5501 5501 initPlainTextareaEditor: function() { … … 5557 5557 * 5558 5558 * @since 4.9.0 5559 * @return s{void}5559 * @return {void} 5560 5560 */ 5561 5561 ready: function ready() { … … 5619 5619 * 5620 5620 * @param {string} datetime - Date/Time string. Accepts Y-m-d[ H:i[:s]] format. 5621 * @return s{object|null} Returns object containing date components or null if parse error.5621 * @return {object|null} Returns object containing date components or null if parse error. 5622 5622 */ 5623 5623 parseDateTime: function parseDateTime( datetime ) { … … 5734 5734 * 5735 5735 * @since 4.9.0 5736 * @return s{boolean} If setting updated.5736 * @return {boolean} If setting updated. 5737 5737 */ 5738 5738 populateSetting: function populateSetting() { … … 5795 5795 * 5796 5796 * @since 4.9.0 5797 * @return s{boolean} True if future date.5797 * @return {boolean} True if future date. 5798 5798 */ 5799 5799 isFutureDate: function isFutureDate() { … … 5808 5808 * @param {string} hourInTwelveHourFormat - Hour in twelve hour format. 5809 5809 * @param {string} meridian - Either 'am' or 'pm'. 5810 * @return s{string} Hour in twenty four hour format.5810 * @return {string} Hour in twenty four hour format. 5811 5811 */ 5812 5812 convertHourToTwentyFourHourFormat: function convertHour( hourInTwelveHourFormat, meridian ) { … … 5833 5833 * 5834 5834 * @since 4.9.0 5835 * @return s{boolean} Whether the inputs were populated.5835 * @return {boolean} Whether the inputs were populated. 5836 5836 */ 5837 5837 populateDateInputs: function populateDateInputs() { … … 5915 5915 * 5916 5916 * @since 4.9.0 5917 * @return s{void}5917 * @return {void} 5918 5918 */ 5919 5919 ready: function ready() { … … 6043 6043 * @param {...string} ids - One or more ids for controls to obtain. 6044 6044 * @param {deferredControlsCallback} [callback] - Function called when all supplied controls exist. 6045 * @returns {wp.customize.Control|undefined|jQuery.promise} Control instance or undefined (if function called with one id param), or promise resolving to requested controls. 6045 * @return {wp.customize.Control|undefined|jQuery.promise} Control instance or undefined (if function called with one id param), 6046 * or promise resolving to requested controls. 6046 6047 * 6047 6048 * @example <caption>Loop over all registered controls.</caption> … … 6104 6105 * @param {...string} ids - One or more ids for sections to obtain. 6105 6106 * @param {deferredSectionsCallback} [callback] - Function called when all supplied sections exist. 6106 * @returns {wp.customize.Section|undefined|jQuery.promise} Section instance or undefined (if function called with one id param), or promise resolving to requested sections. 6107 * @return {wp.customize.Section|undefined|jQuery.promise} Section instance or undefined (if function called with one id param), 6108 * or promise resolving to requested sections. 6107 6109 * 6108 6110 * @example <caption>Loop over all registered sections.</caption> … … 6138 6140 * @param {...string} ids - One or more ids for panels to obtain. 6139 6141 * @param {deferredPanelsCallback} [callback] - Function called when all supplied panels exist. 6140 * @returns {wp.customize.Panel|undefined|jQuery.promise} Panel instance or undefined (if function called with one id param), or promise resolving to requested panels. 6142 * @return {wp.customize.Panel|undefined|jQuery.promise} Panel instance or undefined (if function called with one id param), 6143 * or promise resolving to requested panels. 6141 6144 * 6142 6145 * @example <caption>Loop over all registered panels.</caption> … … 6172 6175 * @param {...string} codes - One or more codes for notifications to obtain. 6173 6176 * @param {deferredNotificationsCallback} [callback] - Function called when all supplied notifications exist. 6174 * @returns {wp.customize.Notification|undefined|jQuery.promise} notification instance or undefined (if function called with one code param), or promise resolving to requested notifications. 6177 * @return {wp.customize.Notification|undefined|jQuery.promise} Notification instance or undefined (if function called with one code param), 6178 * or promise resolving to requested notifications. 6175 6179 * 6176 6180 * @example <caption>Check if existing notification</caption> … … 6601 6605 * @param {object} data.activeSections Active sections. 6602 6606 * @param {object} data.activeControls Active controls. 6603 * @return s{void}6607 * @return {void} 6604 6608 */ 6605 6609 ready: function( data ) { … … 6671 6675 * @access public 6672 6676 * 6673 * @return s{void}6677 * @return {void} 6674 6678 */ 6675 6679 keepPreviewAlive: function keepPreviewAlive() { … … 6732 6736 * @since 3.4.0 6733 6737 * @access public 6734 * @return s{void}6738 * @return {void} 6735 6739 */ 6736 6740 refresh: function() { … … 6906 6910 * @param {object} args.settingValidities 6907 6911 * @param {boolean} [args.focusInvalidControl=false] 6908 * @return s{void}6912 * @return {void} 6909 6913 */ 6910 6914 api._handleSettingValidities = function handleSettingValidities( args ) { … … 6979 6983 * @since 4.6.0 6980 6984 * @param {string[]} settingIds Setting IDs. 6981 * @return s{object<string, wp.customize.Control>} Mapping setting ids to arrays of controls.6985 * @return {object<string, wp.customize.Control>} Mapping setting ids to arrays of controls. 6982 6986 */ 6983 6987 api.findControlsForSettings = function findControlsForSettings( settingIds ) { … … 7427 7431 * @param {string} [args.date] Date, in local time in MySQL format. 7428 7432 * @param {string} [args.title] Title 7429 * @return s{jQuery.promise} Promise.7433 * @return {jQuery.promise} Promise. 7430 7434 */ 7431 7435 save: function( args ) { … … 7700 7704 * @since 4.9.0 7701 7705 * 7702 * @return s{jQuery.promise} Promise.7706 * @return {jQuery.promise} Promise. 7703 7707 */ 7704 7708 trash: function trash() { … … 8034 8038 * 8035 8039 * @param {boolean} isIncluded Is UUID included. 8036 * @return s{void}8040 * @return {void} 8037 8041 */ 8038 8042 populateChangesetUuidParam = function( isIncluded ) { … … 8193 8197 * @param {object} [args.lockUser] - Lock user data. 8194 8198 * @param {boolean} [args.allowOverride=false] - Whether override is allowed. 8195 * @return s{void}8199 * @return {void} 8196 8200 */ 8197 8201 function startLock( args ) { … … 8252 8256 * Obtain the URL to restore the autosave. 8253 8257 * 8254 * @return s{string} Customizer URL.8258 * @return {string} Customizer URL. 8255 8259 */ 8256 8260 function getAutosaveRestorationUrl() { … … 8273 8277 * 8274 8278 * @param {Array} params - Parameter names to remove. 8275 * @return s{void}8279 * @return {void} 8276 8280 */ 8277 8281 function stripParamsFromLocation( params ) { … … 8296 8300 * Dismiss autosave. 8297 8301 * 8298 * @return s{void}8302 * @return {void} 8299 8303 */ 8300 8304 function dismissAutosave() { … … 8315 8319 * Add notification regarding the availability of an autosave to restore. 8316 8320 * 8317 * @return s{void}8321 * @return {void} 8318 8322 */ 8319 8323 function addAutosaveRestoreNotification() { … … 8493 8497 * 8494 8498 * @param {wp.customize.Panel|wp.customize.Section} container Construct. 8495 * @return s{void}8499 * @return {void} 8496 8500 */ 8497 8501 changeContainer = function( container ) { … … 8605 8609 * @access private 8606 8610 * 8607 * @return s{void}8611 * @return {void} 8608 8612 */ 8609 8613 updateHeaderHeight = function() { … … 8620 8624 * @param {number} scrollTop - Scroll top. 8621 8625 * @param {number} scrollDirection - Scroll direction, negative number being up and positive being down. 8622 * @return s{void}8626 * @return {void} 8623 8627 */ 8624 8628 positionStickyHeader = function( header, scrollTop, scrollDirection ) { -
trunk/src/js/_enqueues/wp/customize/nav-menus.js
r46799 r46800 388 388 * @param {Array.<object>} itemTypes List of objects containing type and key. 389 389 * @param {string} deprecated Formerly the object parameter. 390 * @return s{void}390 * @return {void} 391 391 */ 392 392 loadItems: function( itemTypes, deprecated ) { … … 596 596 * 597 597 * @param {jQuery.Event} event Event. 598 * @return s{void}598 * @return {void} 599 599 */ 600 600 _submitNew: function( event ) { … … 622 622 * 623 623 * @param {jQuery} container 624 * @return s{void}624 * @return {void} 625 625 */ 626 626 submitNew: function( container ) { … … 844 844 * @private 845 845 * 846 * @return s{void}846 * @return {void} 847 847 */ 848 848 saveManageColumnsState: _.debounce( function() { … … 878 878 * @private 879 879 * 880 * @return s{Array} Fields (columns) that are hidden.880 * @return {Array} Fields (columns) that are hidden. 881 881 */ 882 882 hidden: function() { … … 974 974 * 975 975 * @this {jQuery} 976 * @return s{void}976 * @return {void} 977 977 */ 978 978 handleFieldActiveToggle = function() { … … 1167 1167 * @since 4.9.0 1168 1168 * 1169 * @return s{void}1169 * @return {void} 1170 1170 */ 1171 1171 highlightNewItemButton: function() { … … 1180 1180 * 1181 1181 * @param {string} [name=''] Nav menu name. 1182 * @return s{wp.customize.Menus.MenuSection} Added nav menu.1182 * @return {wp.customize.Menus.MenuSection} Added nav menu. 1183 1183 */ 1184 1184 api.Menus.createNavMenu = function createNavMenu( name ) { … … 1264 1264 * 1265 1265 * @since 4.9.0 1266 * @return s{number} Count.1266 * @return {number} Count. 1267 1267 */ 1268 1268 function getNavMenuCount() { … … 1280 1280 * 1281 1281 * @since 4.9.0 1282 * @return s{void}1282 * @return {void} 1283 1283 */ 1284 1284 function updateNoticeVisibility() { … … 1291 1291 * @since 4.9.0 1292 1292 * @param {wp.customize.Setting} setting - Added setting. 1293 * @return s{void}1293 * @return {void} 1294 1294 */ 1295 1295 function addChangeEventListener( setting ) { … … 1305 1305 * @since 4.9.0 1306 1306 * @param {wp.customize.Setting} setting - Removed setting. 1307 * @return s{void}1307 * @return {void} 1308 1308 */ 1309 1309 function removeChangeEventListener( setting ) { … … 1440 1440 * 1441 1441 * @param {string|null} locationId - The ID of the location to select. `null` clears all selections. 1442 * @return s{void}1442 * @return {void} 1443 1443 */ 1444 1444 selectDefaultLocation: function( locationId ) { … … 1871 1871 /** 1872 1872 * 1873 * @return s{number}1873 * @return {number} 1874 1874 */ 1875 1875 getDepth: function() { … … 1963 1963 * @param {Boolean} expanded 1964 1964 * @param {Object} [params] 1965 * @return s{Boolean} False if state already applied.1965 * @return {Boolean} False if state already applied. 1966 1966 */ 1967 1967 _toggleExpanded: api.Section.prototype._toggleExpanded, … … 1971 1971 * 1972 1972 * @param {Object} [params] 1973 * @return s{Boolean} False if already expanded.1973 * @return {Boolean} False if already expanded. 1974 1974 */ 1975 1975 expand: api.Section.prototype.expand, … … 1991 1991 * 1992 1992 * @param {Object} [params] 1993 * @return s{Boolean} False if already collapsed.1993 * @return {Boolean} False if already collapsed. 1994 1994 */ 1995 1995 collapse: api.Section.prototype.collapse, … … 2429 2429 * 2430 2430 * @param {Object.<string,boolean>} selections - A map of location selections. 2431 * @return s{void}2431 * @return {void} 2432 2432 */ 2433 2433 setSelections: function( selections ) { … … 2955 2955 * 2956 2956 * @param {object} item - Value for the nav_menu_item setting to be created. 2957 * @return s{wp.customize.Menus.controlConstructor.nav_menu_item} The newly-created nav_menu_item control instance.2957 * @return {wp.customize.Menus.controlConstructor.nav_menu_item} The newly-created nav_menu_item control instance. 2958 2958 */ 2959 2959 addItemToMenu: function( item ) { … … 3374 3374 * 3375 3375 * @param {string} name 3376 * @return s{string}3376 * @return {string} 3377 3377 */ 3378 3378 function displayNavMenuName( name ) { -
trunk/src/js/_enqueues/wp/customize/preview-nav-menus.js
r43347 r46800 135 135 * @param {number|object|false|null} newValue - New value, or null if the setting was just removed. 136 136 * @param {number|object|false|null} oldValue - Old value, or null if the setting was just added. 137 * @return s{boolean}137 * @return {boolean} 138 138 */ 139 139 isRelatedSetting: function( setting, newValue, oldValue ) { … … 211 211 * @since 4.5.0 212 212 * 213 * @return s{Promise}213 * @return {Promise} 214 214 */ 215 215 refresh: function() { -
trunk/src/js/_enqueues/wp/customize/preview-widgets.js
r43347 r46800 17 17 * @param {Object} api Information from the API. 18 18 * 19 * @return s{Object} Widget-related variables.19 * @return {Object} Widget-related variables. 20 20 */ 21 21 wp.customize.widgetsPreview = wp.customize.WidgetCustomizerPreview = (function( $, _, wp, api ) { … … 43 43 * @memberOf wp.customize.widgetsPreview 44 44 * 45 * @return s{void}45 * @return {void} 46 46 */ 47 47 self.init = function() { … … 125 125 * @since 4.5.0 126 126 * 127 * @return s{Promise|void} Either a promise postponing the refresh, or void.127 * @return {Promise|void} Either a promise postponing the refresh, or void. 128 128 */ 129 129 refresh: function() { … … 147 147 * function. 148 148 * 149 * @return s{void}149 * @return {void} 150 150 */ 151 151 renderContent: function( placement ) { … … 206 206 * @since 4.5.0 207 207 * 208 * @return s{void}208 * @return {void} 209 209 */ 210 210 ready: function() { … … 252 252 * @since 4.5.0 253 253 * 254 * @return s{Array.<{before: Comment, after: Comment, instanceNumber: number}>}255 * 256 * 254 * @return {Array.<{before: Comment, after: Comment, instanceNumber: number}>} 255 * An array with an object for each sidebar instance, containing the 256 * node before and after the sidebar instance and its instance number. 257 257 */ 258 258 findDynamicSidebarBoundaryNodes: function() { … … 294 294 * @since 4.5.0 295 295 * 296 * @return s{Array} An array containing placement objects for each of the297 * 296 * @return {Array} An array containing placement objects for each of the 297 * dynamic sidebar boundary nodes. 298 298 */ 299 299 placements: function() { … … 321 321 * @throws {Error} If the API doesn't pass an array of widget ids. 322 322 * 323 * @return s{Array} A shallow copy of the array containing widget IDs.323 * @return {Array} A shallow copy of the array containing widget IDs. 324 324 */ 325 325 getWidgetIds: function() { … … 345 345 * @since 4.5.0 346 346 * 347 * @return s{Array.<wp.customize.selectiveRefresh.Placement>} List of placements348 * 347 * @return {Array.<wp.customize.selectiveRefresh.Placement>} List of placements 348 * that were reflowed. 349 349 */ 350 350 reflowWidgets: function() { … … 413 413 * @param {string} widgetId The widget ID. 414 414 * 415 * @return s{wp.customize.selectiveRefresh.Partial} The widget instance partial.415 * @return {wp.customize.selectiveRefresh.Partial} The widget instance partial. 416 416 */ 417 417 ensureWidgetPlacementContainers: function( widgetId ) { … … 481 481 * @param {Array} oldWidgetIds Old widget IDs. 482 482 * 483 * @return s{void}483 * @return {void} 484 484 */ 485 485 handleSettingChange: function( newWidgetIds, oldWidgetIds ) { … … 536 536 * @since 4.5.0 537 537 * 538 * @return s{Promise} A promise postponing the refresh.538 * @return {Promise} A promise postponing the refresh. 539 539 */ 540 540 refresh: function() { … … 566 566 * @since 4.5.0 567 567 * 568 * @return s{void}568 * @return {void} 569 569 */ 570 570 self.addPartials = function() { … … 591 591 * @since 3.9.0 592 592 * 593 * @return s{void}593 * @return {void} 594 594 */ 595 595 self.buildWidgetSelectors = function() { … … 634 634 * @param {string} widgetId ID of the widget. 635 635 * 636 * @return s{void}636 * @return {void} 637 637 */ 638 638 self.highlightWidget = function( widgetId ) { … … 656 656 * @since 3.9.0 657 657 * 658 * @return s{void}658 * @return {void} 659 659 */ 660 660 self.highlightControls = function() { … … 693 693 * @param {string} widgetId The widget ID. 694 694 * 695 * @return s {{idBase: string, number: number|null}} An object containing the696 * idBaseand number of the parsed widget ID.695 * @return {{idBase: string, number: number|null}} An object containing the idBase 696 * and number of the parsed widget ID. 697 697 */ 698 698 self.parseWidgetId = function( widgetId ) { … … 722 722 * @param {string} settingId Widget setting ID. 723 723 * 724 * @return s {{idBase: string, number: number|null}|null} Either an object725 * containing the idBase and number of the parsed widget setting ID, or726 * null.724 * @return {{idBase: string, number: number|null}|null} Either an object containing the idBase 725 * and number of the parsed widget setting ID, 726 * or null. 727 727 */ 728 728 self.parseWidgetSettingId = function( settingId ) { … … 752 752 * @param {string} widgetId The widget ID. 753 753 * 754 * @return s{string} The setting ID.754 * @return {string} The setting ID. 755 755 */ 756 756 self.getWidgetSettingId = function( widgetId ) { -
trunk/src/js/_enqueues/wp/customize/preview.js
r44684 r46800 29 29 * 30 30 * @param {string} url URL. 31 * @return s{string} URL with customized state.31 * @return {string} URL with customized state. 32 32 */ 33 33 injectUrlWithState = function( url ) { … … 235 235 * 236 236 * @access private 237 * @return s{void}237 * @return {void} 238 238 */ 239 239 api.addLinkPreviewing = function addLinkPreviewing() { … … 279 279 * @param {object} [options] 280 280 * @param {object} [options.allowAdminAjax=false] Allow admin-ajax.php requests. 281 * @return s{boolean} Is appropriate for changeset link.281 * @return {boolean} Is appropriate for changeset link. 282 282 */ 283 283 api.isLinkPreviewable = function isLinkPreviewable( element, options ) { … … 333 333 * @param {string} element.host Host. 334 334 * @param {string} element.protocol Protocol. 335 * @return s{void}335 * @return {void} 336 336 */ 337 337 api.prepareLinkPreview = function prepareLinkPreview( element ) { … … 405 405 * @param {object} originalOptions Original options. 406 406 * @param {XMLHttpRequest} xhr XHR. 407 * @return s{void}407 * @return {void} 408 408 */ 409 409 var prefilterAjax = function( options, originalOptions, xhr ) { … … 471 471 * @access protected 472 472 * 473 * @return s{void}473 * @return {void} 474 474 */ 475 475 api.addFormPreviewing = function addFormPreviewing() { … … 503 503 * 504 504 * @param {HTMLFormElement} form Form. 505 * @return s{void}505 * @return {void} 506 506 */ 507 507 api.prepareFormPreview = function prepareFormPreview( form ) { … … 627 627 * 628 628 * @param {number} attachmentId Attachment ID for custom logo. 629 * @return s{void}629 * @return {void} 630 630 */ 631 631 custom_logo: function( attachmentId ) { … … 637 637 * 638 638 * @param {string} value Custom CSS.. 639 * @return s{void}639 * @return {void} 640 640 */ 641 641 custom_css: function( value ) { … … 646 646 * Preview changes to any of the background settings. 647 647 * 648 * @return s{void}648 * @return {void} 649 649 */ 650 650 background: function() { … … 776 776 * 777 777 * @param {string} uuid - UUID. 778 * @return s{void}778 * @return {void} 779 779 */ 780 780 handleUpdatedChangesetUuid = function( uuid ) { -
trunk/src/js/_enqueues/wp/customize/selective-refresh.js
r46586 r46800 121 121 * 122 122 * @param {Placement} placement The placement container element. 123 * @return s{void}123 * @return {void} 124 124 */ 125 125 createEditShortcutForPlacement: function( placement ) { … … 151 151 * @param {Placement} placement The placement for the partial. 152 152 * @param {jQuery} $editShortcut The shortcut element as a jQuery object. 153 * @return s{void}153 * @return {void} 154 154 */ 155 155 addEditShortcutToPlacement: function( placement, $editShortcut ) { … … 409 409 * @param {string|object|boolean} placement.addedContent - Rendered HTML content, a data object for JS templates to render, or false if no render. 410 410 * @param {object} [placement.context] - Optional context information about the container. 411 * @return s{boolean} Whether the rendering was successful and the fallback was not invoked.411 * @return {boolean} Whether the rendering was successful and the fallback was not invoked. 412 412 */ 413 413 renderContent: function( placement ) { -
trunk/src/js/_enqueues/wp/customize/widgets.js
r46799 r46800 1040 1040 * 1041 1041 * @param {jQuery} container element in which to look for inputs 1042 * @return s{jQuery} inputs1042 * @return {jQuery} inputs 1043 1043 * @private 1044 1044 */ … … 1052 1052 * 1053 1053 * @param {jQuery} inputs 1054 * @return s{string}1054 * @return {string} 1055 1055 * @private 1056 1056 */ … … 1075 1075 * 1076 1076 * @param {jQuery|Element} input 1077 * @return s{string|boolean|array|*}1077 * @return {string|boolean|array|*} 1078 1078 * @private 1079 1079 */ … … 1341 1341 * @param {Boolean} expanded 1342 1342 * @param {Object} [params] 1343 * @return s{Boolean} False if state already applied.1343 * @return {Boolean} False if state already applied. 1344 1344 */ 1345 1345 _toggleExpanded: api.Section.prototype._toggleExpanded, … … 1349 1349 * 1350 1350 * @param {Object} [params] 1351 * @return s{Boolean} False if already expanded.1351 * @return {Boolean} False if already expanded. 1352 1352 */ 1353 1353 expand: api.Section.prototype.expand, … … 1366 1366 * 1367 1367 * @param {Object} [params] 1368 * @return s{Boolean} False if already collapsed.1368 * @return {Boolean} False if already collapsed. 1369 1369 */ 1370 1370 collapse: api.Section.prototype.collapse, … … 1496 1496 * Get the position (index) of the widget in the containing sidebar 1497 1497 * 1498 * @return s{Number}1498 * @return {Number} 1499 1499 */ 1500 1500 getWidgetSidebarPosition: function() { … … 1653 1653 * Update the notice. 1654 1654 * 1655 * @return s{void}1655 * @return {void} 1656 1656 */ 1657 1657 updateNotice = function() { … … 1709 1709 * @since 4.4.0 1710 1710 * 1711 * @return s{boolean}1711 * @return {boolean} 1712 1712 */ 1713 1713 isContextuallyActive: function() { … … 2062 2062 /** 2063 2063 * @param {string} widgetId or an id_base for adding a previously non-existing widget. 2064 * @return s{object|false} widget_form control instance, or false on error.2064 * @return {object|false} widget_form control instance, or false on error. 2065 2065 */ 2066 2066 addWidget: function( widgetId ) { … … 2331 2331 /** 2332 2332 * @param {String} widgetId 2333 * @return s{Object}2333 * @return {Object} 2334 2334 */ 2335 2335 function parseWidgetId( widgetId ) { … … 2353 2353 /** 2354 2354 * @param {String} widgetId 2355 * @return s{String} settingId2355 * @return {String} settingId 2356 2356 */ 2357 2357 function widgetIdToSettingId( widgetId ) { -
trunk/src/js/_enqueues/wp/dashboard.js
r44896 r46800 24 24 * @param {boolean} visible Should it be visible or not. 25 25 * 26 * @return s{void}26 * @return {void} 27 27 */ 28 28 updateWelcomePanel = function( visible ) { … … 73 73 * @param {string} el Optional. Widget to fetch or none to update all. 74 74 * 75 * @return s{void}75 * @return {void} 76 76 */ 77 77 window.ajaxPopulateWidgets = function(el) { … … 82 82 * @param {string} id ID of the element which is going to be checked for changes. 83 83 * 84 * @return s{void}84 * @return {void} 85 85 */ 86 86 function show(i, id) { … … 128 128 * @global 129 129 * 130 * @return s{void}130 * @return {void} 131 131 */ 132 132 window.quickPressLoad = function() { … … 160 160 * Highlights the latest post for one second. 161 161 * 162 * @return s{void}162 * @return {void} 163 163 */ 164 164 function highlightLatestPost () { … … 190 190 * @since 3.6.0 191 191 * 192 * @return s{void}192 * @return {void} 193 193 */ 194 194 function autoResizeTextarea() { … … 286 286 * @since 4.8.0 287 287 * 288 * @return s{void}288 * @return {void} 289 289 */ 290 290 init: function() { … … 320 320 * Filters events based on entered location. 321 321 * 322 * @return s{void}322 * @return {void} 323 323 */ 324 324 $container.on( 'submit', '.community-events-form', function( event ) { … … 357 357 * or an event object to flip between states. 358 358 * 359 * @return s{void}359 * @return {void} 360 360 */ 361 361 toggleLocationForm: function( action ) { … … 402 402 * @param {Object} requestParams REST API Request parameters object. 403 403 * 404 * @return s{void}404 * @return {void} 405 405 */ 406 406 getEvents: function( requestParams ) { … … 456 456 * 'app' to indicate it was triggered automatically by the app itself. 457 457 * 458 * @return s{void}458 * @return {void} 459 459 */ 460 460 renderEventsTemplate: function( templateParams, initiatedBy ) { -
trunk/src/js/_enqueues/wp/editor/base.js
r46799 r46800 27 27 * @since 4.3.0 28 28 * 29 * @return s{void}29 * @return {void} 30 30 */ 31 31 $$( document ).on( 'click', function( event ) { … … 48 48 * 49 49 * @param {Object} editor The TinyMCE editor. 50 * @return s{number} If the height is between 10 and 200 return the height,50 * @return {number} If the height is between 10 and 200 return the height, 51 51 * else return 30. 52 52 */ … … 71 71 * @param {string} id The id of the editor you want to change the editor mode for. Default: `content`. 72 72 * @param {string} mode The mode you want to switch to. Default: `toggle`. 73 * @return s{void}73 * @return {void} 74 74 */ 75 75 function switchEditor( id, mode ) { … … 203 203 * @param {number} cursorPosition The cursor position inside the content. 204 204 * 205 * @return s{(null|Object)} Null if cursor is not in a tag, Object if the cursor is inside a tag.205 * @return {(null|Object)} Null if cursor is not in a tag, Object if the cursor is inside a tag. 206 206 */ 207 207 function getContainingTagInfo( content, cursorPosition ) { … … 660 660 * 661 661 * @param {Object} editor The editor where we must find the selection. 662 * @return s{(null|Object)} The selection range position in the editor.662 * @return {(null|Object)} The selection range position in the editor. 663 663 */ 664 664 function findBookmarkedPosition( editor ) { … … 1005 1005 * 1006 1006 * @param {string} text The text input. 1007 * @return s{string} The formatted text.1007 * @return {string} The formatted text. 1008 1008 */ 1009 1009 function autop( text ) { … … 1132 1132 * 1133 1133 * @param {String} html The content from the visual editor. 1134 * @return s{String} the filtered content.1134 * @return {String} the filtered content. 1135 1135 */ 1136 1136 function pre_wpautop( html ) { … … 1158 1158 * 1159 1159 * @param {String} text The content from the text editor. 1160 * @return s{String} filtered content.1160 * @return {String} filtered content. 1161 1161 */ 1162 1162 function wpautop( text ) { -
trunk/src/js/_enqueues/wp/editor/dfw.js
r45172 r46800 16 16 * @since 4.0.0 17 17 * 18 * @return s{void}18 * @return {void} 19 19 */ 20 20 $( function() { … … 71 71 * @since 4.6.1 72 72 * 73 * @return s{void}73 * @return {void} 74 74 */ 75 75 var shrinkTextarea = window._.throttle( function() { … … 103 103 * @since 4.6.1 104 104 * 105 * @return s{void}105 * @return {void} 106 106 */ 107 107 function textEditorResize() { … … 136 136 * @since 4.0.0 137 137 * 138 * @return s{void}138 * @return {void} 139 139 */ 140 140 function getHeights() { … … 170 170 * @param {object} editor The editor to bind the vents on. 171 171 * 172 * @return s{void}172 * @return {void} 173 173 */ 174 174 $document.on( 'tinymce-editor-init.editor-expand', function( event, editor ) { … … 178 178 * Hides any float panel with a hover state. Additionally hides tooltips. 179 179 * 180 * @return s{void}180 * @return {void} 181 181 */ 182 182 hideFloatPanels = _.debounce( function() { … … 205 205 * Gets the offset of the editor. 206 206 * 207 * @return s{Number|Boolean} Returns the offset of the editor207 * @return {Number|Boolean} Returns the offset of the editor 208 208 * or false if there is no offset height. 209 209 */ … … 242 242 * @param {event} event The event to get the key code from. 243 243 * 244 * @return s{void}244 * @return {void} 245 245 */ 246 246 function mceKeyup( event ) { … … 271 271 * @param {string} key The key code of the pressed key. 272 272 * 273 * @return s{void}273 * @return {void} 274 274 */ 275 275 function mceScroll( key ) { … … 332 332 * @param {event} event The FullscreenStateChanged event. 333 333 * 334 * @return s{void}334 * @return {void} 335 335 */ 336 336 function mceFullscreenToggled( event ) { … … 349 349 * @since 4.0.0 350 350 * 351 * @return s{void}351 * @return {void} 352 352 */ 353 353 function mceShow() { … … 368 368 * @since 4.0.0 369 369 * 370 * @return s{void}370 * @return {void} 371 371 */ 372 372 function mceHide() { … … 392 392 * @since 4.1.0 393 393 * 394 * @return s{void}394 * @return {void} 395 395 */ 396 396 function toggleAdvanced() { … … 403 403 * @since 4.0.0 404 404 * 405 * @return s{void}405 * @return {void} 406 406 */ 407 407 mceBind = function() { … … 428 428 * @since 4.0.0 429 429 * 430 * @return s{void}430 * @return {void} 431 431 */ 432 432 mceUnbind = function() { … … 461 461 * @param {event} event The event that calls this function. 462 462 * 463 * @return s{void}463 * @return {void} 464 464 */ 465 465 function adjust( event ) { … … 773 773 * @since 4.0.0 774 774 * 775 * @return s{void}775 * @return {void} 776 776 */ 777 777 function fullscreenHide() { … … 787 787 * @param {function} callback The function to run in the timeout. 788 788 * 789 * @return s{void}789 * @return {void} 790 790 */ 791 791 function initialResize( callback ) { … … 800 800 * @since 4.0.0 801 801 * 802 * @return s{void}802 * @return {void} 803 803 */ 804 804 function afterScroll() { … … 812 812 * @since 4.0.0 813 813 * 814 * @return s{void}814 * @return {void} 815 815 */ 816 816 function on() { … … 882 882 * @since 4.0.0 883 883 * 884 * @return s{void}884 * @return {void} 885 885 */ 886 886 function off() { … … 976 976 * @since 4.1.0 977 977 * 978 * @return s{void}978 * @return {void} 979 979 */ 980 980 $( function() { … … 1026 1026 * @since 4.1.0 1027 1027 * 1028 * @return s{void}1028 * @return {void} 1029 1029 */ 1030 1030 function recalcEditorRect() { … … 1039 1039 * @since 4.1.0 1040 1040 * 1041 * @return s{void}1041 * @return {void} 1042 1042 */ 1043 1043 function activate() { … … 1055 1055 * @since 4.1.0 1056 1056 * 1057 * @return s{void}1057 * @return {void} 1058 1058 */ 1059 1059 function deactivate() { … … 1073 1073 * @since 4.1.0 1074 1074 * 1075 * @return s{boolean} Returns true is _isActive is true.1075 * @return {boolean} Returns true is _isActive is true. 1076 1076 */ 1077 1077 function isActive() { … … 1084 1084 * @since 4.1.0 1085 1085 * 1086 * @return s{void}1086 * @return {void} 1087 1087 */ 1088 1088 function on() { … … 1107 1107 * @since 4.1.0 1108 1108 * 1109 * @return s{void}1109 * @return {void} 1110 1110 */ 1111 1111 function off() { … … 1130 1130 * @since 4.1.0 1131 1131 * 1132 * @return s{void}1132 * @return {void} 1133 1133 */ 1134 1134 function toggle() { … … 1145 1145 * @since 4.1.0 1146 1146 * 1147 * @return s{boolean} Returns true if _isOn is true.1147 * @return {boolean} Returns true if _isOn is true. 1148 1148 */ 1149 1149 function isOn() { … … 1162 1162 * @param event The event that triggers this function. 1163 1163 * 1164 * @return s{void}1164 * @return {void} 1165 1165 */ 1166 1166 function fadeOut( event ) { … … 1301 1301 * @param event The event that triggers this function. 1302 1302 * 1303 * @return s{void}1303 * @return {void} 1304 1304 */ 1305 1305 function fadeIn( event ) { … … 1347 1347 * @since 4.1.0 1348 1348 * 1349 * @return s{void}1349 * @return {void} 1350 1350 */ 1351 1351 function maybeFadeIn() { … … 1369 1369 * @since 4.1.0 1370 1370 * 1371 * @return s{void}1371 * @return {void} 1372 1372 */ 1373 1373 function fadeOutAdminBar() { … … 1390 1390 * @since 4.1.0 1391 1391 * 1392 * @return s{void}1392 * @return {void} 1393 1393 */ 1394 1394 function fadeInAdminBar() { … … 1405 1405 * @since 4.1.0 1406 1406 * 1407 * @return s{void}1407 * @return {void} 1408 1408 */ 1409 1409 function fadeOutSlug() { … … 1422 1422 * @since 4.1.0 1423 1423 * 1424 * @return s{void}1424 * @return {void} 1425 1425 */ 1426 1426 function fadeInSlug() { … … 1443 1443 * @param {event} event The event to trigger the toggle. 1444 1444 * 1445 * @return s{void}1445 * @return {void} 1446 1446 */ 1447 1447 function toggleViaKeyboard( event ) { … … 1463 1463 * @param {object} editor The editor to add the button to. 1464 1464 * 1465 * @return s{void}1465 * @return {void} 1466 1466 */ 1467 1467 $document.on( 'tinymce-editor-setup.focus', function( event, editor ) { … … 1512 1512 * @param {object} editor The editor to bind events on. 1513 1513 * 1514 * @return s{void}1514 * @return {void} 1515 1515 */ 1516 1516 $document.on( 'tinymce-editor-init.focus', function( event, editor ) { … … 1569 1569 * @param {object} editor The editor to bind events on. 1570 1570 * 1571 * @return s{void}1571 * @return {void} 1572 1572 */ 1573 1573 $document.on( 'quicktags-init', function( event, editor ) { -
trunk/src/js/_enqueues/wp/heartbeat.js
r44275 r46800 35 35 * @since 3.6.0 36 36 * 37 * @return s{Object} An instance of the Heartbeat class.37 * @return {Object} An instance of the Heartbeat class. 38 38 * @constructor 39 39 */ … … 111 111 * @since 3.8.0 112 112 * 113 * @return s{void}113 * @return {void} 114 114 */ 115 115 function initialize() { … … 250 250 * @since 3.6.0 251 251 * 252 * @return s{number} Returns the current time.252 * @return {number} Returns the current time. 253 253 */ 254 254 function time() { … … 263 263 * @since 3.6.0 264 264 * 265 * @return s{boolean} Returns whether or not the iframe is from the same origin.265 * @return {boolean} Returns whether or not the iframe is from the same origin. 266 266 */ 267 267 function isLocalFrame( frame ) { … … 296 296 * @since 4.1.0 297 297 * 298 * @return s{void}298 * @return {void} 299 299 */ 300 300 function checkFocus() { … … 317 317 * (200, 404, 500, etc.). 318 318 * 319 * @return s{void}319 * @return {void} 320 320 */ 321 321 function setErrorState( error, status ) { … … 364 364 * @since 3.8.0 365 365 * 366 * @return s{void}366 * @return {void} 367 367 */ 368 368 function clearErrorState() { … … 385 385 * @since 3.6.0 386 386 * 387 * @return s{void}387 * @return {void} 388 388 */ 389 389 function connect() { … … 485 485 * @since 3.8.0 486 486 * 487 * @return s{void}487 * @return {void} 488 488 */ 489 489 function scheduleNextTick() { … … 531 531 * @since 3.6.0 532 532 * 533 * @return s{void}533 * @return {void} 534 534 */ 535 535 function blurred() { … … 544 544 * @since 3.6.0 545 545 * 546 * @return s{void}546 * @return {void} 547 547 */ 548 548 function focused() { … … 565 565 * @since 3.6.0 566 566 * 567 * @return s{void}567 * @return {void} 568 568 */ 569 569 function userIsActive() { … … 591 591 * @since 3.8.0 592 592 * 593 * @return s{void}593 * @return {void} 594 594 */ 595 595 function checkUserActivity() { … … 633 633 * @memberOf wp.heartbeat.prototype 634 634 * 635 * @return s{boolean} True if the window or the user is active.635 * @return {boolean} True if the window or the user is active. 636 636 */ 637 637 function hasFocus() { … … 646 646 * @memberOf wp.heartbeat.prototype 647 647 * 648 * @return s{boolean} True if a connection error was found.648 * @return {boolean} True if a connection error was found. 649 649 */ 650 650 function hasConnectionError() { … … 662 662 * @memberOf wp.heartbeat.prototype 663 663 * 664 * @return s{void}664 * @return {void} 665 665 */ 666 666 function connectNow() { … … 681 681 * @memberOf wp.heartbeat.prototype 682 682 * 683 * @return s{void}683 * @return {void} 684 684 */ 685 685 function disableSuspend() { … … 704 704 * back. Used with speed = 'fast' or 5. 705 705 * 706 * @return s{number} Current interval in seconds.706 * @return {number} Current interval in seconds. 707 707 */ 708 708 function interval( speed, ticks ) { … … 785 785 * @param {boolean} noOverwrite Whether to overwrite existing data in the queue. 786 786 * 787 * @return s{boolean} True if the data was queued.787 * @return {boolean} True if the data was queued. 788 788 */ 789 789 function enqueue( handle, data, noOverwrite ) { … … 806 806 * @param {string} handle The handle for the data. 807 807 * 808 * @return s{boolean} True if the data is queued with this handle.808 * @return {boolean} True if the data is queued with this handle. 809 809 */ 810 810 function isQueued( handle ) { … … 823 823 * @param {string} handle The handle for the data. 824 824 * 825 * @return s{void}825 * @return {void} 826 826 */ 827 827 function dequeue( handle ) { … … 840 840 * @param {string} handle The handle for the data. 841 841 * 842 * @return s{*} The data or undefined.842 * @return {*} The data or undefined. 843 843 */ 844 844 function getQueuedItem( handle ) { -
trunk/src/js/_enqueues/wp/media/audiovideo.js
r43347 r46800 150 150 * 151 151 * @param {string} data The text to apply the shortcode on. 152 * @return s{wp.media} The media object.152 * @return {wp.media} The media object. 153 153 */ 154 154 edit : function( data ) { … … 170 170 * 171 171 * @param {Array} model Array with attributes for the shortcode. 172 * @return s{wp.shortcode} The audio shortcode object.172 * @return {wp.shortcode} The audio shortcode object. 173 173 */ 174 174 shortcode : function( model ) { … … 225 225 * 226 226 * @param {string} data The text to apply the shortcode on. 227 * @return s{wp.media} The media object.227 * @return {wp.media} The media object. 228 228 */ 229 229 edit : function( data ) { … … 250 250 * 251 251 * @param {Array} model Array with attributes for the shortcode. 252 * @return s{wp.shortcode} The video shortcode object.252 * @return {wp.shortcode} The video shortcode object. 253 253 */ 254 254 shortcode : function( model ) { -
trunk/src/js/_enqueues/wp/media/editor.js
r46799 r46800 22 22 * @param {object} attrs Map of props from a shortcode or settings. 23 23 * @param {string} key The key within the passed map to check for a value. 24 * @return s{mixed|undefined} The original or coerced value of key within attrs.24 * @return {mixed|undefined} The original or coerced value of key within attrs. 25 25 */ 26 26 wp.media.coerce = function ( attrs, key ) { … … 44 44 * @param {Object} [props={}] Attachment details (align, link, size, etc). 45 45 * @param {Object} attachment The attachment object, media version of Post. 46 * @return s{Object} Joined props46 * @return {Object} Joined props 47 47 */ 48 48 props: function( props, attachment ) { … … 110 110 * @param {Object} props Attachment details (align, link, size, etc). 111 111 * @param {Object} attachment The attachment object, media version of Post. 112 * @return s{string} The link markup112 * @return {string} The link markup 113 113 */ 114 114 link: function( props, attachment ) { … … 136 136 * @param {Object} props Attachment details (align, link, size, etc). 137 137 * @param {Object} attachment The attachment object, media version of Post. 138 * @return s{string} The audio shortcode138 * @return {string} The audio shortcode 139 139 */ 140 140 audio: function( props, attachment ) { … … 146 146 * @param {Object} props Attachment details (align, link, size, etc). 147 147 * @param {Object} attachment The attachment object, media version of Post. 148 * @return s{string} The video shortcode148 * @return {string} The video shortcode 149 149 */ 150 150 video: function( props, attachment ) { … … 159 159 * @param {Object} props Attachment details (align, link, size, etc). 160 160 * @param {Object} attachment The attachment object, media version of Post. 161 * @return s{string} The media shortcode161 * @return {string} The media shortcode 162 162 */ 163 163 _audioVideo: function( type, props, attachment ) { … … 206 206 * @param {Object} props Attachment details (align, link, size, etc). 207 207 * @param {Object} attachment The attachment object, media version of Post. 208 * @return s{string}208 * @return {string} 209 209 */ 210 210 image: function( props, attachment ) { … … 346 346 * 347 347 * @param {wp.shortcode} shortcode An instance of wp.shortcode(). 348 * @return s{wp.media.model.Attachments} A Backbone.Collection containing349 * the media items belonging to a collection.350 * The query[ this.tag ] property is a Backbone.Model351 * containing the 'props' for the collection.348 * @return {wp.media.model.Attachments} A Backbone.Collection containing 349 * the media items belonging to a collection. 350 * The query[ this.tag ] property is a Backbone.Model 351 * containing the 'props' for the collection. 352 352 */ 353 353 attachments: function( shortcode ) { … … 415 415 * The query[ this.tag ] property is a Backbone.Model 416 416 * containing the 'props' for the collection. 417 * @return s{wp.shortcode}417 * @return {wp.shortcode} 418 418 */ 419 419 shortcode: function( attachments ) { … … 484 484 * @this wp.media.{prop} 485 485 * 486 * @return s{wp.media.view.MediaFrame.Select} A media workflow.486 * @return {wp.media.view.MediaFrame.Select} A media workflow. 487 487 */ 488 488 edit: function( content ) { … … 604 604 * Get the featured image post ID 605 605 * 606 * @return s{wp.media.view.settings.post.featuredImageId|number}606 * @return {wp.media.view.settings.post.featuredImageId|number} 607 607 */ 608 608 get: function() { … … 643 643 * @this wp.media.featuredImage 644 644 * 645 * @return s{wp.media.view.MediaFrame.Select} A media workflow.645 * @return {wp.media.view.MediaFrame.Select} A media workflow. 646 646 */ 647 647 frame: function() { … … 776 776 * @this wp.media.editor 777 777 * 778 * @return s{wp.media.view.MediaFrame.Select} A media workflow.778 * @return {wp.media.view.MediaFrame.Select} A media workflow. 779 779 */ 780 780 add: function( id, options ) { … … 880 880 * @param {string} [id=''] A slug used to identify the workflow. 881 881 * 882 * @return s{wpActiveEditor|string|tinymce.activeEditor.id}882 * @return {wpActiveEditor|string|tinymce.activeEditor.id} 883 883 */ 884 884 id: function( id ) { … … 906 906 * @this wp.media.editor 907 907 * 908 * @return s{wp.media.view.MediaFrame} A media workflow.908 * @return {wp.media.view.MediaFrame} A media workflow. 909 909 */ 910 910 get: function( id ) { … … 931 931 * @param {Object} props Attachment details (align, link, size, etc). 932 932 * @param {Object} attachment The attachment object, media version of Post. 933 * @return s{Promise}933 * @return {Promise} 934 934 */ 935 935 attachment: function( props, attachment ) { … … 985 985 * 986 986 * @param {Object} embed 987 * @return s{Promise}987 * @return {Promise} 988 988 */ 989 989 link: function( embed ) { … … 1005 1005 * @this wp.media.editor 1006 1006 * 1007 * @return s{wp.media.view.MediaFrame}1007 * @return {wp.media.view.MediaFrame} 1008 1008 */ 1009 1009 open: function( id, options ) { -
trunk/src/js/_enqueues/wp/media/models.js
r43347 r46800 139 139 * 140 140 * @param {Object} dimensions 141 * @return s{Object}141 * @return {Object} 142 142 */ 143 143 fit: function( dimensions ) { … … 185 185 * @param {Number} [length=30] 186 186 * @param {String} [replacement=…] 187 * @return s{String} The string, unless length is greater than string.length.187 * @return {String} The string, unless length is greater than string.length. 188 188 */ 189 189 truncate: function( string, length, replacement ) { … … 209 209 * @static 210 210 * @param {String} id A string used to identify a model. 211 * @return s{wp.media.model.Attachment}211 * @return {wp.media.model.Attachment} 212 212 */ 213 213 media.attachment = function( id ) { … … 229 229 * 230 230 * @param {object} [props] 231 * @return s{wp.media.model.Attachments}231 * @return {wp.media.model.Attachments} 232 232 */ 233 233 media.query = function( props ) { -
trunk/src/js/_enqueues/wp/media/views.js
r44969 r46800 50 50 * @param {string} selector 51 51 * @param {Number} sensitivity 52 * @return s{Promise}52 * @return {Promise} 53 53 */ 54 54 media.transition = function( selector, sensitivity ) { -
trunk/src/js/_enqueues/wp/password-strength-meter.js
r43577 r46800 28 28 * @param {string} password2 The password confirmation. 29 29 * 30 * @return s{number} The password strength score.30 * @return {number} The password strength score. 31 31 */ 32 32 meter : function( password1, blacklist, password2 ) { … … 55 55 * @since 3.7.0 56 56 * 57 * @return s{string[]} The array of words to be blacklisted.57 * @return {string[]} The array of words to be blacklisted. 58 58 */ 59 59 userInputBlacklist : function() { -
trunk/src/js/_enqueues/wp/theme-plugin-editor.js
r46586 r46800 37 37 * @param {object} settings - Settings. 38 38 * @param {object|boolean} settings.codeEditor - Code editor settings (or `false` if syntax highlighting is disabled). 39 * @return s{void}39 * @return {void} 40 40 */ 41 41 component.init = function init( form, settings ) { … … 95 95 * 96 96 * @since 4.9.0 97 * @return s{void}97 * @return {void} 98 98 */ 99 99 component.showWarning = function() { … … 126 126 * @since 4.9.0 127 127 * @param {object} event jQuery event object. 128 * @return s{void}128 * @return {void} 129 129 */ 130 130 component.constrainTabbing = function( event ) { … … 151 151 * 152 152 * @since 4.9.0 153 * @return s{void}153 * @return {void} 154 154 */ 155 155 component.dismissWarning = function() { … … 169 169 * 170 170 * @since 4.9.0 171 * @return s{void}171 * @return {void} 172 172 */ 173 173 component.onChange = function() { … … 181 181 * @since 4.9.0 182 182 * @param {jQuery.Event} event - Event. 183 * @return s{void}183 * @return {void} 184 184 */ 185 185 component.submit = function( event ) { … … 268 268 * @param {boolean} [notice.dismissible=false] - Dismissible. 269 269 * @param {Function} [notice.onDismiss] - Callback for when a user dismisses the notice. 270 * @return s{jQuery} Notice element.270 * @return {jQuery} Notice element. 271 271 */ 272 272 component.addNotice = function( notice ) { … … 304 304 * 305 305 * @param {string} code - Notice code. 306 * @return s{boolean} Whether a notice was removed.306 * @return {boolean} Whether a notice was removed. 307 307 */ 308 308 component.removeNotice = function( code ) { … … 321 321 * 322 322 * @since 4.9.0 323 * @return s{void}323 * @return {void} 324 324 */ 325 325 component.initCodeEditor = function initCodeEditor() { … … 333 333 * @since 4.9.0 334 334 * 335 * @return s{void}335 * @return {void} 336 336 */ 337 337 codeEditorSettings.onTabPrevious = function() { … … 344 344 * @since 4.9.0 345 345 * 346 * @return s{void}