WordPress.org

Make WordPress Core

Changeset 46800


Ignore:
Timestamp:
11/29/2019 05:59:47 PM (12 months ago)
Author:
SergeyBiryukov
Message:

Docs: Replace @returns tags in JS docs with @return.

Per the documentation standards, @returns is an unsupported synonym, @return should be used instead:
https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/

See #48303.

Location:
trunk/src/js
Files:
86 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/js/_enqueues/admin/comment.js

    r43347 r46800  
    2828     *
    2929     * @param {Event} event The event object.
    30      * @returns {void}
     30     * @return {void}
    3131     */
    3232    $edittimestamp.click( function( event ) {
     
    4747     *
    4848     * @param {Event} event The event object.
    49      * @returns {void}
     49     * @return {void}
    5050     */
    5151
     
    6969     *
    7070     * @param {Event} event The event object.
    71      * @returns {void}
     71     * @return {void}
    7272     */
    7373    $timestampdiv.find('.save-timestamp').click( function( event ) { // crazyhorse - multiple ok cancels
  • trunk/src/js/_enqueues/admin/common.js

    r46250 r46800  
    4343     * @since 2.7.0
    4444     *
    45      * @returns {void}
     45     * @return {void}
    4646     */
    4747    init : function() {
     
    6565     * @since 3.0.0
    6666     *
    67      * @returns {void}
     67     * @return {void}
    6868     */
    6969    saveManageColumnsState : function() {
     
    8383     * @param {string} column The column name.
    8484     *
    85      * @returns {void}
     85     * @return {void}
    8686     */
    8787    checked : function(column) {
     
    9696     * @param {string} column The column name.
    9797     *
    98      * @returns {void}
     98     * @return {void}
    9999     */
    100100    unchecked : function(column) {
     
    108108     * @since 3.0.0
    109109     *
    110      * @returns {string} The hidden column names separated by a comma.
     110     * @return {string} The hidden column names separated by a comma.
    111111     */
    112112    hidden : function() {
     
    121121     * @since 3.0.0
    122122     *
    123      * @returns {string} String containing the checked column names.
     123     * @return {string} String containing the checked column names.
    124124     */
    125125    useCheckboxesForHidden : function() {
     
    157157 * @param {jQuery} form The form to validate.
    158158 *
    159  * @returns {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.
    160160 */
    161161window.validateForm = function( form ) {
     
    177177 * @type {{warn: showNotice.warn, note: showNotice.note}}
    178178 *
    179  * @returns {void}
     179 * @return {void}
    180180 */
    181181window.showNotice = {
     
    186186     * @since 2.7.0
    187187     *
    188      * @returns {boolean} Returns true if the message is confirmed.
     188     * @return {boolean} Returns true if the message is confirmed.
    189189     */
    190190    warn : function() {
     
    218218 *         close: screenMeta.close}}
    219219 *
    220  * @returns {void}
     220 * @return {void}
    221221 */
    222222window.screenMeta = {
     
    230230     * @since 3.2.0
    231231     *
    232      * @returns {void}
     232     * @return {void}
    233233     */
    234234    init: function() {
     
    245245     * @since 3.2.0
    246246     *
    247      * @returns {void}
     247     * @return {void}
    248248     */
    249249    toggleEvent: function() {
     
    267267     * @param {jQuery} button The toggle button.
    268268     *
    269      * @returns {void}
     269     * @return {void}
    270270     */
    271271    open: function( panel, button ) {
     
    280280         * @since 3.2.0
    281281         *
    282          * @returns {void}
     282         * @return {void}
    283283         */
    284284        panel.slideDown( 'fast', function() {
     
    298298     * @param {jQuery} button The toggle button.
    299299     *
    300      * @returns {void}
     300     * @return {void}
    301301     */
    302302    close: function( panel, button ) {
     
    306306         * @since 3.2.0
    307307         *
    308          * @returns {void}
     308         * @return {void}
    309309         */
    310310        panel.slideUp( 'fast', function() {
     
    323323 * @param {Event} e The event object.
    324324 *
    325  * @returns {void}
     325 * @return {void}
    326326 */
    327327$('.contextual-help-tabs').delegate('a', 'click', function(e) {
     
    504504     * @param {Event} e The event object.
    505505     *
    506      * @returns {void}
     506     * @return {void}
    507507     */
    508508    $adminmenu.on('click.wp-submenu-head', '.wp-submenu-head', function(e){
     
    513513     * Collapses the admin menu.
    514514     *
    515      * @returns {void}
     515     * @return {void}
    516516     */
    517517    $( '#collapse-button' ).on( 'click.collapse-menu', function() {
     
    552552     * @since 4.4.0
    553553     *
    554      * @returns {void}
     554     * @return {void}
    555555     */
    556556    function currentMenuItemHasPopup() {
     
    575575     * @param {jQuery} $menuItem The parent menu item containing the submenu.
    576576     *
    577      * @returns {void}
     577     * @return {void}
    578578     */
    579579    function adjustSubmenu( $menuItem ) {
     
    614614         * @param {Event} e The event object.
    615615         *
    616          * @returns {void}
     616         * @return {void}
    617617         */
    618618        $body.on( mobileEvent+'.wp-mobile-hover', function(e) {
     
    631631         * @param {Event} event The event object.
    632632         *
    633          * @returns {void}
     633         * @return {void}
    634634         */
    635635        $adminmenu.find( 'a.wp-has-submenu' ).on( mobileEvent + '.wp-mobile-hover', function( event ) {
     
    658658             * Opens the submenu when hovered over the menu item for desktops.
    659659             *
    660              * @returns {void}
     660             * @return {void}
    661661             */
    662662            over: function() {
     
    682682             * Closes the submenu when no longer hovering the menu item.
    683683             *
    684              * @returns {void}
     684             * @return {void}
    685685             */
    686686            out: function(){
     
    702702         * @param {Event} event The event object.
    703703         *
    704          * @returns {void}
     704         * @return {void}
    705705         */
    706706        $adminmenu.on( 'focus.adminmenu', '.wp-submenu a', function( event ) {
     
    717717             * @param {Event} event The event object.
    718718             *
    719              * @returns {void}
     719             * @return {void}
    720720             */
    721721        }).on( 'blur.adminmenu', '.wp-submenu a', function( event ) {
     
    729729             * Adjusts the size for the submenu.
    730730             *
    731              * @returns {void}
     731             * @return {void}
    732732             */
    733733        }).find( 'li.wp-has-submenu.wp-not-current-submenu' ).on( 'focusin.adminmenu', function() {
     
    752752     * @since 4.4.0
    753753     *
    754      * @returns {void}
     754     * @return {void}
    755755     */
    756756    function makeNoticesDismissible() {
     
    785785     * This event needs to be delegated. Ticket #37973.
    786786     *
    787      * @returns {boolean} Returns whether a checkbox is checked or not.
     787     * @return {boolean} Returns whether a checkbox is checked or not.
    788788     */
    789789    $body.on( 'click', 'tbody > tr > .check-column :checkbox', function( event ) {
     
    814814         * Determines if all checkboxes are checked.
    815815         *
    816          * @returns {boolean} Returns true if there are no unchecked checkboxes.
     816         * @return {boolean} Returns true if there are no unchecked checkboxes.
    817817         */
    818818        $(this).closest('table').children('thead, tfoot').find(':checkbox').prop('checked', function() {
     
    833833     * @param {Event} event The event object.
    834834     *
    835      * @returns {boolean}
     835     * @return {boolean}
    836836     */
    837837    $body.on( 'click.wp-toggle-checkboxes', 'thead .check-column :checkbox, tfoot .check-column :checkbox', function( event ) {
     
    846846             * Updates the checked state on the checkbox in the table.
    847847             *
    848              * @returns {boolean} True checks the checkbox, False unchecks the checkbox.
     848             * @return {boolean} True checks the checkbox, False unchecks the checkbox.
    849849             */
    850850            .prop('checked', function() {
     
    868868             * Syncs the bulk checkboxes on the top and bottom of the table.
    869869             *
    870              * @returns {boolean} True checks the checkbox, False unchecks the checkbox.
     870             * @return {boolean} True checks the checkbox, False unchecks the checkbox.
    871871             */
    872872            .prop('checked', function() {
     
    884884     * Shows row actions on focus of its parent container element or any other elements contained within.
    885885     *
    886      * @returns {void}
     886     * @return {void}
    887887     */
    888888    $( '#wpbody-content' ).on({
     
    919919     * @param {Event} e The event object.
    920920     *
    921      * @returns {void}
     921     * @return {void}
    922922     */
    923923    $('#newcontent').bind('keydown.wpevent_InsertTab', function(e) {
     
    978978         * The form closest to the pageInput is the post-filter form.
    979979         *
    980          * @returns {void}
     980         * @return {void}
    981981         */
    982982        pageInput.closest('form').submit( function() {
     
    993993     * Resets the bulk actions when the search button is clicked.
    994994     *
    995      * @returns {void}
     995     * @return {void}
    996996     */
    997997    $('.search-box input[type="search"], .search-box input[type="submit"]').mousedown(function () {
     
    10041004     * @param {Event} e The event object.
    10051005     *
    1006      * @returns {void}
     1006     * @return {void}
    10071007     */
    10081008    $('#contextual-help-link, #show-settings-link').on( 'focus.scroll-into-view', function(e){
     
    10141014     * Disables the submit upload buttons when no data is entered.
    10151015     *
    1016      * @returns {void}
     1016     * @return {void}
    10171017     */
    10181018    (function(){
     
    10311031         * @since 3.5.0
    10321032         *
    1033          * @returns {void}
     1033         * @return {void}
    10341034         */
    10351035        function toggleUploadButton() {
     
    10531053     * @since 4.1.0
    10541054     *
    1055      * @returns {void}
     1055     * @return {void}
    10561056     */
    10571057    function pinMenu( event ) {
     
    11961196     * @since 4.1.0
    11971197     *
    1198      * @returns {void}
     1198     * @return {void}
    11991199     */
    12001200    function resetHeights() {
     
    12121212     * @since 4.1.0
    12131213     *
    1214      * @returns {void}
     1214     * @return {void}
    12151215     */
    12161216    function unpinMenu() {
     
    12321232     * @since 4.1.0
    12331233     *
    1234      * @returns {void}
     1234     * @return {void}
    12351235     */
    12361236    function setPinMenu() {
     
    12611261     * @since 3.8.0
    12621262     *
    1263      *@returns {void}
     1263     * @return {void}
    12641264     */
    12651265    window.wpResponsive = {
     
    12701270         * @since 3.8.0
    12711271         *
    1272          * @returns {void}
     1272         * @return {void}
    12731273         */
    12741274        init: function() {
     
    13281328         * @since 5.3.0
    13291329         *
    1330          * @returns {void}
     1330         * @return {void}
    13311331         */
    13321332        maybeDisableSortables: function() {
     
    13511351         * @since 3.8.0
    13521352         *
    1353          * @returns {void}
     1353         * @return {void}
    13541354         */
    13551355        activate: function() {
     
    13721372         * @since 3.8.0
    13731373         *
    1374          * @returns {void}
     1374         * @return {void}
    13751375         */
    13761376        deactivate: function() {
     
    13861386         * @since 3.8.0
    13871387         *
    1388          * @returns {void}
     1388         * @return {void}
    13891389         */
    13901390        trigger: function() {
     
    14221422         * @since 3.8.0
    14231423         *
    1424          * @returns {void}
     1424         * @return {void}
    14251425         */
    14261426        enableOverlay: function() {
     
    14451445         * @since 3.8.0
    14461446         *
    1447          * @returns {void}
     1447         * @return {void}
    14481448         */
    14491449        disableOverlay: function() {
     
    14571457         * @since 3.8.0
    14581458         *
    1459          * @returns {void}
     1459         * @return {void}
    14601460         */
    14611461        disableSortables: function() {
     
    14731473         * @since 3.8.0
    14741474         *
    1475          * @returns {void}
     1475         * @return {void}
    14761476         */
    14771477        enableSortables: function() {
     
    14901490     * @since 4.5.0
    14911491     *
    1492      * @returns {void}
     1492     * @return {void}
    14931493     */
    14941494    function aria_button_if_js() {
     
    15051505     * @since 4.7.0
    15061506     *
    1507      * @returns {number|boolean} The current viewport width or false if the
    1508      *                           browser doesn't support innerWidth (IE < 9).
     1507     * @return {number|boolean} The current viewport width or false if the
     1508     *                          browser doesn't support innerWidth (IE < 9).
    15091509     */
    15101510    function getViewportWidth() {
     
    15271527     * @since 4.7.0
    15281528     *
    1529      * @returns {void}
     1529     * @return {void}
    15301530     */
    15311531    function setMenuState() {
     
    15551555     * @since 4.7.0
    15561556     *
    1557      * @returns {void}
     1557     * @return {void}
    15581558     */
    15591559    $document.on( 'wp-menu-state-set wp-collapse-menu', function( event, eventData ) {
     
    16141614     * @since 3.8.0
    16151615     *
    1616      * @returns {void}
     1616     * @return {void}
    16171617     */
    16181618    function triggerEvent() {
     
    16251625     * @since 3.8.0
    16261626     *
    1627      * @returns {void}
     1627     * @return {void}
    16281628     */
    16291629    function fireOnce() {
  • trunk/src/js/_enqueues/admin/custom-background.js

    r43347 r46800  
    2222         * @since 3.5.0
    2323         *
    24          * @returns {void}
     24         * @return {void}
    2525         */
    2626        $('#background-color').wpColorPicker({
     
    3838         * @since 4.7.0
    3939         *
    40          * @returns {void}
     40         * @return {void}
    4141         */
    4242        $( 'select[name="background-size"]' ).change( function() {
     
    4949         * @since 4.7.0
    5050         *
    51          * @returns {void}
     51         * @return {void}
    5252         */
    5353        $( 'input[name="background-position"]' ).change( function() {
     
    6060         * @since 3.0.0
    6161         *
    62          * @returns {void}
     62         * @return {void}
    6363         */
    6464        $( 'input[name="background-repeat"]' ).change( function() {
     
    7171         * @since 4.7.0
    7272         *
    73          * @returns {void}
     73         * @return {void}
    7474         */
    7575        $( 'input[name="background-attachment"]' ).change( function() {
     
    8282         * @since 3.5.0
    8383         *
    84          * @returns {void}
     84         * @return {void}
    8585         */
    8686        $('#choose-from-library-link').click( function( event ) {
     
    122122             * @since 3.5.0
    123123             *
    124              * @returns {void}
     124             * @return {void}
    125125             */
    126126            frame.on( 'select', function() {
  • trunk/src/js/_enqueues/admin/custom-header.js

    r43347 r46800  
    3434         * @deprecated 4.1.0
    3535         *
    36          * @returns {void}
     36         * @return {void}
    3737         */
    3838        $('#choose-from-library-link').click( function( event ) {
     
    7272             * @deprecated 4.1.0
    7373             *
    74              * @returns {void}
     74             * @return {void}
    7575             */
    7676            frame.on( 'select', function() {
  • trunk/src/js/_enqueues/admin/inline-edit-post.js

    r45417 r46800  
    3737     * @since 2.7.0
    3838     *
    39      * @returns {void}
     39     * @return {void}
    4040     */
    4141    init : function(){
     
    4949         * Binds the escape key to revert the changes and close the quick editor.
    5050         *
    51          * @returns {boolean} The result of revert.
     51         * @return {boolean} The result of revert.
    5252         */
    5353        qeRow.keyup(function(e){
     
    6161         * Binds the escape key to revert the changes and close the bulk editor.
    6262         *
    63          * @returns {boolean} The result of revert.
     63         * @return {boolean} The result of revert.
    6464         */
    6565        bulkRow.keyup(function(e){
     
    7373         * Reverts changes and close the quick editor if the cancel button is clicked.
    7474         *
    75          * @returns {boolean} The result of revert.
     75         * @return {boolean} The result of revert.
    7676         */
    7777        $( '.cancel', qeRow ).click( function() {
     
    8282         * Saves changes in the quick editor if the save(named: update) button is clicked.
    8383         *
    84          * @returns {boolean} The result of save.
     84         * @return {boolean} The result of save.
    8585         */
    8686        $( '.save', qeRow ).click( function() {
     
    9191         * If enter is pressed, and the target is not the cancel button, save the post.
    9292         *
    93          * @returns {boolean} The result of save.
     93         * @return {boolean} The result of save.
    9494         */
    9595        $('td', qeRow).keydown(function(e){
     
    102102         * Reverts changes and close the bulk editor if the cancel button is clicked.
    103103         *
    104          * @returns {boolean} The result of revert.
     104         * @return {boolean} The result of revert.
    105105         */
    106106        $( '.cancel', bulkRow ).click( function() {
     
    248248     * @param {number|Object} id The id of the clicked post or an element within a post
    249249     *                           table row.
    250      * @returns {boolean} Always returns false at the end of execution.
     250     * @return {boolean} Always returns false at the end of execution.
    251251     */
    252252    edit : function(id) {
     
    286286             * Replaces the image for a Twemoji(Twitter emoji) with it's alternate text.
    287287             *
    288              * @returns Alternate text from the image.
     288             * @return {string} Alternate text from the image.
    289289             */
    290290            val.find( 'img' ).replaceWith( function() { return this.alt; } );
     
    386386     * @since 2.7.0
    387387     *
    388      * @param   {int}     id The id for the post that has been changed.
    389      * @returns {boolean}    false, so the form does not submit when pressing
    390      *                       Enter on a focused field.
     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.
    391391     */
    392392    save : function(id) {
     
    454454     * @since 2.7.0
    455455     *
    456      * @returns {boolean} Always returns false.
     456     * @return {boolean} Always returns false.
    457457     */
    458458    revert : function(){
     
    498498     * @since 2.7.0
    499499     *
    500      * @param   {Object} o DOM row object to get the id for.
    501      * @returns {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.
    502502     */
    503503    getId : function(o) {
  • trunk/src/js/_enqueues/admin/inline-edit-tax.js

    r43577 r46800  
    3030     * @this inlineEditTax
    3131     * @memberof inlineEditTax
    32      * @returns {void}
     32     * @return {void}
    3333     */
    3434    init : function() {
     
    9797     * @param {HTMLElement} el An element within the table row or the table row
    9898     *                         itself that we want to quick edit.
    99      * @returns {void}
     99     * @return {void}
    100100     */
    101101    toggle : function(el) {
     
    116116     *                                element within the table row or the
    117117     * table row itself.
    118      * @returns {boolean} Always returns false.
     118     * @return {boolean} Always returns false.
    119119     */
    120120    edit : function(id) {
     
    163163     *                                element within the table row or the
    164164     * table row itself.
    165      * @returns {boolean} Always returns false.
     165     * @return {boolean} Always returns false.
    166166     */
    167167    save : function(id) {
     
    256256     * @this inlineEditTax
    257257     * @memberof inlineEditTax
    258      * @returns {void}
     258     * @return {void}
    259259     */
    260260    revert : function() {
     
    281281     *
    282282     * @param {HTMLElement} o An element within the table row or the table row itself.
    283      * @returns {string} The ID of the term based on the element.
     283     * @return {string} The ID of the term based on the element.
    284284     */
    285285    getId : function(o) {
  • trunk/src/js/_enqueues/admin/link.js

    r43352 r46800  
    123123     *
    124124     * @param {Event} event The event object.
    125      * @returns {boolean} Always returns false to prevent regular link
    126      *                    functionality.
     125     * @return {boolean} Always returns false to prevent regular link
     126     *                   functionality.
    127127     */
    128128    $('#category-add-toggle').click( function() {
  • trunk/src/js/_enqueues/admin/media-upload.js

    r43577 r46800  
    2323 *
    2424 * @param {string} html The HTML to be sent to the editor.
    25  * @returns {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.
     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.
    2828 */
    2929window.send_to_editor = function( html ) {
     
    7272     * @global
    7373     *
    74      * @returns {Object[]} Array containing jQuery objects for all the found
    75      *                     ThickBox anchors.
     74     * @return {Object[]} Array containing jQuery objects for all the found
     75     *                    ThickBox anchors.
    7676     */
    7777    window.tb_position = function() {
  • trunk/src/js/_enqueues/admin/media.js

    r43577 r46800  
    2727         * @param {string} af_val The value of the affected post element.
    2828         *
    29          * @returns {boolean} Always returns false.
     29         * @return {boolean} Always returns false.
    3030         */
    3131        open: function( af_name, af_val ) {
     
    6666         * @memberOf findPosts
    6767         *
    68          * @returns {void}
     68         * @return {void}
    6969         */
    7070        close: function() {
     
    8282         * @memberOf findPosts
    8383         *
    84          * @returns {void}
     84         * @return {void}
    8585         */
    8686        overlay: function() {
     
    101101         * @memberOf findPosts
    102102         *
    103          * @returns {void}
     103         * @return {void}
    104104         */
    105105        send: function() {
     
    139139     * various form elements.
    140140     *
    141      * @returns {void}
     141     * @return {void}
    142142     */
    143143    $( document ).ready( function() {
     
    199199         * Enables clicking on the entire table row.
    200200         *
    201          * @returns {void}
     201         * @return {void}
    202202         */
    203203        $( '.find-box-inside' ).on( 'click', 'tr', function() {
  • trunk/src/js/_enqueues/admin/post.js

    r45979 r46800  
    3636         * @param {int} total Total number of comments for this post.
    3737         * @param {int} num   Optional. Number of comments to fetch, defaults to 20.
    38          * @returns {boolean} Always returns false.
     38         * @return {boolean} Always returns false.
    3939         */
    4040        get : function(total, num) {
     
    600600         * @param {Object} s Taxonomy object which will be added.
    601601         *
    602          * @returns {Object}
     602         * @return {Object}
    603603         */
    604604        catAddBefore = function( s ) {
     
    621621         * @param {Object} s Taxonomy data.
    622622         *
    623          * @returns void
     623         * @return {void}
    624624         */
    625625        catAddAfter = function( r, s ) {
     
    667667             * @param {Object} s Request object.
    668668             *
    669              * @returns {Object} Data modified with post_ID attached.
     669             * @return {Object} Data modified with post_ID attached.
    670670             */
    671671            addBefore: function( s ) {
     
    696696         * @ignore
    697697         *
    698          * @returns void
     698         * @return {void}
    699699         */
    700700        updateVisibility = function() {
     
    720720         * @ignore
    721721         *
    722          * @returns {boolean} False when an invalid timestamp has been selected, otherwise True.
     722         * @return {boolean} False when an invalid timestamp has been selected, otherwise True.
    723723         */
    724724        updateText = function() {
     
    942942     * @global
    943943     *
    944      * @returns void
     944     * @return {void}
    945945     */
    946946    function editPermalink() {
     
    10521052     * @global
    10531053     *
    1054      * @returns void
     1054     * @return {void}
    10551055     */
    10561056    window.wptitlehint = function( id ) {
  • trunk/src/js/_enqueues/admin/postbox.js

    r43577 r46800  
    3636         * @fires postboxes#postbox-toggled
    3737         *
    38          * @returns {void}
     38         * @return {void}
    3939         */
    4040        handle_click : function () {
     
    9797         * @param {Function} args.pbshow A callback that is called when a postbox opens.
    9898         * @param {Function} args.pbhide A callback that is called when a postbox closes.
    99          * @returns {void}
     99         * @return {void}
    100100         */
    101101        add_postbox_toggles : function (page, args) {
     
    122122             * @since 3.2.0
    123123             *
    124              * @returns {void}
     124             * @return {void}
    125125             */
    126126            $( '.postbox a.dismiss' ).on( 'click.postboxes', function( e ) {
     
    141141             * @fires postboxes#postbox-toggled
    142142             *
    143              * @returns {void}
     143             * @return {void}
    144144             */
    145145            $('.hide-postbox-tog').bind('click.postboxes', function() {
     
    175175             * @since 2.8.0
    176176             *
    177              * @returns {void}
     177             * @return {void}
    178178             */
    179179            $('.columns-prefs input[type="radio"]').bind('click.postboxes', function(){
     
    199199         *                               closes.
    200200         *
    201          * @returns {void}
     201         * @return {void}
    202202         */
    203203        init : function(page, args) {
     
    276276         *
    277277         * @param {string} page The page we are currently on.
    278          * @returns {void}
     278         * @return {void}
    279279         */
    280280        save_state : function(page) {
     
    307307         *
    308308         * @param {string} page The page we are currently on.
    309          * @returns {void}
     309         * @return {void}
    310310         */
    311311        save_order : function(page) {
     
    337337         * @access private
    338338         *
    339          * @returns {void}
     339         * @return {void}
    340340         */
    341341        _mark_area : function() {
     
    371371         *
    372372         * @param {number} n The amount of columns to divide the post edit page in.
    373          * @returns {void}
     373         * @return {void}
    374374         */
    375375        _pb_edit : function(n) {
     
    399399         * @access private
    400400         *
    401          * @returns {void}
     401         * @return {void}
    402402         */
    403403        _pb_change : function() {
  • trunk/src/js/_enqueues/admin/tags-suggest.js

    r45227 r46800  
    3232     *
    3333     * @param {object} options Options that are passed to UI Autocomplete. Can be used to override the default settings.
    34      * @returns {object} jQuery instance.
     34     * @return {object} jQuery instance.
    3535     */
    3636    $.fn.wpTagsSuggest = function( options ) {
  • trunk/src/js/_enqueues/admin/tags.js

    r45683 r46800  
    2121     * @since 2.8.0
    2222     *
    23      * @returns boolean Always returns false to cancel the default event handling.
     23     * @return {boolean} Always returns false to cancel the default event handling.
    2424     */
    2525    $( '#the-list' ).on( 'click', '.delete-tag', function() {
     
    3838             * @param {string} r The response from the server.
    3939             *
    40              * @returns {void}
     40             * @return {void}
    4141             */
    4242            $.post(ajaxurl, data, function(r){
     
    7676     * @since 4.8.0
    7777     *
    78      * @returns {void}
     78     * @return {void}
    7979     */
    8080    $( '#edittag' ).on( 'click', '.delete', function( e ) {
     
    9797     * @since 2.8.0
    9898     *
    99      * @returns boolean Always returns false to cancel the default event handling.
     99     * @return {boolean} Always returns false to cancel the default event handling.
    100100     */
    101101    $('#submit').click(function(){
     
    118118         * @param {string} r The response from the server.
    119119         *
    120          * @returns {void}
     120         * @return {void}
    121121         */
    122122        $.post(ajaxurl, $('#addtag').serialize(), function(r){
  • trunk/src/js/_enqueues/lib/color-picker.js

    r46799 r46800  
    4040         * @access private
    4141         *
    42          * @returns {void}
     42         * @return {void}
    4343         */
    4444        _createHueOnly: function() {
     
    6666                 * @param {HTMLElement} ui The HTMLElement containing the color picker.
    6767                 *
    68                  * @returns {void}
     68                 * @return {void}
    6969                 */
    7070                change: function( event, ui ) {
     
    8484         * @access private
    8585         *
    86          * @returns {void}
     86         * @return {void}
    8787         */
    8888        _create: function() {
     
    187187                 * @param {HTMLElement} ui The HTMLElement containing the color picker.
    188188                 *
    189                  * @returns {void}
     189                 * @return {void}
    190190                 */
    191191                change: function( event, ui ) {
     
    213213         * @access private
    214214         *
    215          * @returns {void}
     215         * @return {void}
    216216         */
    217217        _addListeners: function() {
     
    225225             * @param {Event} event The event that's being called.
    226226             *
    227              * @returs {void}
     227             * @return {void}
    228228             */
    229229            self.wrap.on( 'click.wpcolorpicker', function( event ) {
     
    234234             * Open or close the color picker depending on the class.
    235235             *
    236              * @since 3.5
     236             * @since 3.5.0
    237237             */
    238238            self.toggler.click( function(){
     
    252252             * @param {Event} event The event that's being called.
    253253             *
    254              * @returns {void}
     254             * @return {void}
    255255             */
    256256            self.element.change( function( event ) {
     
    274274             * @param {Event} event The event that's being called.
    275275             *
    276              * @returns {void}
     276             * @return {void}
    277277             */
    278278            self.button.click( function( event ) {
     
    294294         * @since 3.5.0
    295295         *
    296          * @returns {void}
     296         * @return {void}
    297297         */
    298298        open: function() {
     
    310310         * @since 3.5.0
    311311         *
    312          * @returns {void}
     312         * @return {void}
    313313         */
    314314        close: function() {
     
    328328         * @since 3.5.0
    329329         *
    330          * @returns {string} The element's color.
     330         * @return {string} The element's color.
    331331         */
    332332        color: function( newColor ) {
     
    344344         * @since 3.5.0
    345345         *
    346          * @returns {boolean|string} The element's color.
     346         * @return {boolean|string} The element's color.
    347347         */
    348348        defaultColor: function( newDefaultColor ) {
  • trunk/src/js/_enqueues/lib/image-edit.js

    r46355 r46800  
    7777     *                            instead of true or false.
    7878     *
    79      * @returns {void}
     79     * @return {void}
    8080     */
    8181    setDisabled : function( el, s ) {
     
    101101     * @param {number} postid The post id.
    102102     *
    103      * @returns {void}
     103     * @return {void}
    104104     */
    105105    init : function(postid) {
     
    145145     * @param {number} toggle Is 0 or 1, fades the icon in then 1 and out when 0.
    146146     *
    147      * @returns {void}
     147     * @return {void}
    148148     */
    149149    toggleEditor : function(postid, toggle) {
     
    165165     * @param {HTMLElement} el The element to create the help window in.
    166166     *
    167      * @returns {boolean} Always returns false.
     167     * @return {boolean} Always returns false.
    168168     */
    169169    toggleHelp : function(el) {
     
    187187     * @param {number} postid The post id.
    188188     *
    189      * @returns {string} The value from the imagedit-save-target input field when available,
    190      *                   or 'full' when not available.
     189     * @return {string} The value from the imagedit-save-target input field when available,
     190     *                  or 'full' when not available.
    191191     */
    192192    getTarget : function(postid) {
     
    207207     * @param {jQuery}         el     Element.
    208208     *
    209      * @returns {void}
     209     * @return {void}
    210210     */
    211211    scaleChanged : function( postid, x, el ) {
     
    240240     * @param {number} postid The post id.
    241241     *
    242      * @returns {string} The aspect ratio.
     242     * @return {string} The aspect ratio.
    243243     */
    244244    getSelRatio : function(postid) {
     
    268268     * @param {number} setSize 0 or 1, when 1 the image resets to its original size.
    269269     *
    270      * @returns {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.
    271271     */
    272272    filterHistory : function(postid, setSize) {
     
    334334     * @param {function} callback Function to execute when the image is loaded.
    335335     *
    336      * @returns {void}
     336     * @return {void}
    337337     */
    338338    refreshEditor : function(postid, nonce, callback) {
     
    408408     *                          The possible actions are: "scale" and "restore".
    409409     *
    410      * @returns {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.
     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.
    414414     */
    415415    action : function(postid, nonce, action) {
     
    473473     * @param {string}  nonce    The nonce to verify the request.
    474474     *
    475      * @returns {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.
     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.
    478478     */
    479479    save : function(postid, nonce) {
     
    539539     * @param {object} view     The image editor view to be used for the editing.
    540540     *
    541      * @returns {void|promise} Either returns void if the button was already activated
    542      *                         or returns an instance of the image editor, wrapped in a promise.
     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.
    543543     */
    544544    open : function( postid, nonce, view ) {
     
    594594     * @param {number} postid The post id.
    595595     *
    596      * @returns {void}
     596     * @return {void}
    597597     */
    598598    imgLoaded : function(postid) {
     
    622622     * @param {HTMLElement} parent The preview image container.
    623623     *
    624      * @returns {void}
     624     * @return {void}
    625625     */
    626626    initCrop : function(postid, image, parent) {
     
    654654                 * Binds mouse down event to the cropping container.
    655655                 *
    656                  * @returns {void}
     656                 * @return {void}
    657657                 */
    658658                parent.children().on( 'mousedown, touchstart', function(e){
     
    676676             * @ignore
    677677             *
    678              * @returns {void}
     678             * @return {void}
    679679             */
    680680            onSelectStart: function() {
     
    689689             * @param {object} c   The selection.
    690690             *
    691              * @returns {object}
     691             * @return {object}
    692692             */
    693693            onSelectEnd: function(img, c) {
     
    703703             * @param {object} c   The selection.
    704704             *
    705              * @returns {void}
     705             * @return {void}
    706706             */
    707707            onSelectChange: function(img, c) {
     
    722722     * @param {object} c      The selection.
    723723     *
    724      * @returns {boolean}
     724     * @return {boolean}
    725725     */
    726726    setCropSelection : function(postid, c) {
     
    753753     * @param {bool}    warn   Warning message.
    754754     *
    755      * @returns {void|bool} Returns false if there is a warning.
     755     * @return {void|bool} Returns false if there is a warning.
    756756     */
    757757    close : function(postid, warn) {
     
    793793     * @param {number} postid The post id.
    794794     *
    795      * @returns {boolean} Returns true if the history is not saved.
     795     * @return {boolean} Returns true if the history is not saved.
    796796     */
    797797    notsaved : function(postid) {
     
    819819     * @param {string} nonce  The nonce.
    820820     *
    821      * @returns {void}
     821     * @return {void}
    822822     */
    823823    addStep : function(op, postid, nonce) {
     
    853853     * @param {object} t      The target element.
    854854     *
    855      * @returns {boolean}
     855     * @return {boolean}
    856856     */
    857857    rotate : function(angle, postid, nonce, t) {
     
    874874     * @param {object} t      The target element.
    875875     *
    876      * @returns {boolean}
     876     * @return {boolean}
    877877     */
    878878    flip : function (axis, postid, nonce, t) {
     
    894894     * @param {object} t      The target object.
    895895     *
    896      * @returns {void|boolean} Returns false if the crop button is disabled.
     896     * @return {void|boolean} Returns false if the crop button is disabled.
    897897     */
    898898    crop : function (postid, nonce, t) {
     
    922922     * @param {string} nonce    The nonce.
    923923     *
    924      * @returns {void|false} Returns false if the undo button is disabled.
     924     * @return {void|false} Returns false if the undo button is disabled.
    925925     */
    926926    undo : function (postid, nonce) {
     
    955955     * @param {string} nonce  The nonce.
    956956     *
    957      * @returns {void}
     957     * @return {void}
    958958     */
    959959    redo : function(postid, nonce) {
     
    985985     * @param {jQuery} el     The element containing the values.
    986986     *
    987      * @returns {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.
     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.
    990990     */
    991991    setNumSelection : function( postid, el ) {
     
    10411041     * @param {number} num The number.
    10421042     *
    1043      * @returns {number} The number rounded to a whole number.
     1043     * @return {number} The number rounded to a whole number.
    10441044     */
    10451045    round : function(num) {
     
    10721072     * @param {jQuery} el         The element containing the values.
    10731073     *
    1074      * @returns {void}
     1074     * @return {void}
    10751075     */
    10761076    setRatioSelection : function(postid, n, el) {
     
    11141114     * @param {jQuery} el The html element.
    11151115     *
    1116      * @returns {void|boolean} Returns false if the value is not numeric,
    1117      *                         void when it is.
     1116     * @return {void|boolean} Returns false if the value is not numeric,
     1117     *                        void when it is.
    11181118     */
    11191119    validateNumeric: function( el ) {
  • trunk/src/js/_enqueues/lib/lists.js

    r43347 r46800  
    114114         * @param {string}      action          The type of action to perform: 'add', 'delete', or 'dim'.
    115115         * @param {string}      backgroundColor Background color of the list's DOM element.
    116          * @returns {boolean} Whether to proceed with the action or not.
     116         * @return {boolean} Whether to proceed with the action or not.
    117117         */
    118118        confirm: null,
     
    125125         * @callback wpList~addBefore
    126126         * @param {object} settings Settings for the Ajax request.
    127          * @returns {object|boolean} Settings for the Ajax request or false to abort.
     127         * @return {object|boolean} Settings for the Ajax request or false to abort.
    128128         */
    129129        addBefore: null,
     
    150150         * @param {object}      settings Settings for the Ajax request.
    151151         * @param {HTMLElement} list     The list DOM element.
    152          * @returns {object|boolean} Settings for the Ajax request or false to abort.
     152         * @return {object|boolean} Settings for the Ajax request or false to abort.
    153153         */
    154154        delBefore: null,
     
    174174         * @callback wpList~dimBefore
    175175         * @param {object} settings Settings for the Ajax request.
    176          * @returns {object|boolean} Settings for the Ajax request or false to abort.
     176         * @return {object|boolean} Settings for the Ajax request or false to abort.
    177177         */
    178178        dimBefore: null,
     
    204204     * @param {jQuery} element  Element that triggered the request.
    205205     * @param {object} settings Settings for the Ajax request.
    206      * @returns {string|number} Nonce
     206     * @return {string|number} Nonce
    207207     */
    208208    nonce: function( element, settings ) {
     
    238238     * @param  {HTMLElement} element The DOM element.
    239239     * @param  {string}      type    The type of data to look for: 'list', 'add', 'delete', or 'dim'.
    240      * @returns {Array} Extracted list item data.
     240     * @return {Array} Extracted list item data.
    241241     */
    242242    parseData: function( element, type ) {
     
    261261     * @param {object}      settings Settings for this list.
    262262     * @param {string}      action   The type of action to perform: 'add', 'delete', or 'dim'.
    263      * @returns {object|boolean} Settings if confirmed, false if not.
     263     * @return {object|boolean} Settings if confirmed, false if not.
    264264     */
    265265    pre: function( list, settings, action ) {
     
    299299     * @param {HTMLElement} element  The DOM element.
    300300     * @param {object}      settings Settings for this list.
    301      * @returns {boolean} Whether the item was added.
     301     * @return {boolean} Whether the item was added.
    302302     */
    303303    ajaxAdd: function( element, settings ) {
     
    401401     * @param {HTMLElement} element  A DOM element containing item data.
    402402     * @param {object}      settings Settings for this list.
    403      * @returns {boolean} Whether the item was deleted.
     403     * @return {boolean} Whether the item was deleted.
    404404     */
    405405    ajaxDel: function( element, settings ) {
     
    488488     * @param {HTMLElement} element  A DOM element containing item data.
    489489     * @param {object}      settings Settings for this list.
    490      * @returns {boolean} Whether the item was dim'ed.
     490     * @return {boolean} Whether the item was dim'ed.
    491491     */
    492492    ajaxDim: function( element, settings ) {
     
    612612     *
    613613     * @param {jQuery|string} element Element to check.
    614      * @returns {string} Background color value in HEX. Default: '#ffffff'.
     614     * @return {string} Background color value in HEX. Default: '#ffffff'.
    615615     */
    616616    getColor: function( element ) {
     
    623623     * @param {HTMLElement} element  A DOM element containing item data.
    624624     * @param {object}      settings Settings for this list.
    625      * @returns {boolean} Whether the item was added.
     625     * @return {boolean} Whether the item was added.
    626626     */
    627627    add: function( element, settings ) {
     
    836836 * @param {wpList~dimBefore} settings.dimBefore   Callback that's run before an item gets dim'd. Default: null.
    837837 * @param {wpList~dimAfter}  settings.dimAfter    Callback that's run after an item got dim'd. Default: null.
    838  * @returns {$.fn} wpList API function.
     838 * @return {$.fn} wpList API function.
    839839 */
    840840$.fn.wpList = function( settings ) {
  • trunk/src/js/_enqueues/vendor/mediaelement/wp-mediaelement.js

    r43309 r46800  
    1717         * @since 4.4.0
    1818         *
    19          * @returns {void}
     19         * @return {void}
    2020         */
    2121        function initialize() {
     
    5555             * @param {object} media The wrapper that mimics all the native events/properties/methods for all renderers.
    5656             * @param {object} node  The original HTML video, audio, or iframe tag where the media was loaded.
    57              * @returns {string}
     57             * @return {string}
    5858             */
    5959            settings.customError = function ( media, node ) {
  • trunk/src/js/_enqueues/vendor/mediaelement/wp-playlist.js

    r43309 r46800  
    178178     *
    179179     * @since 4.9.3
    180      * @returns {void}
     180     * @return {void}
    181181     */
    182182    function initialize() {
  • trunk/src/js/_enqueues/wp/a11y.js

    r45979 r46800  
    2222     * @param {String} [ariaLive] The politeness level for aria-live. Possible values:
    2323     *                            polite or assertive. Default polite.
    24      * @returns {void}
     24     * @return {void}
    2525     */
    2626    function speak( message, ariaLive ) {
  • trunk/src/js/_enqueues/wp/api.js

    r46586 r46800  
    836836             * @param {Backbone.Model} model.
    837837             * @param {{beforeSend}, *} options.
    838              * @returns {*}.
     838             * @return {*}.
    839839             */
    840840            sync: function( method, model, options ) {
     
    989989             * @param {Backbone.Model} model.
    990990             * @param {{success}, *} options.
    991              * @returns {*}.
     991             * @return {*}.
    992992             */
    993993            sync: function( method, model, options ) {
     
    10641064             *
    10651065             * @param {data: {page}} options.
    1066              * @returns {*}.
     1066             * @return {*}.
    10671067             */
    10681068            more: function( options ) {
     
    10901090             * Returns true if there are more pages of objects available.
    10911091             *
    1092              * @returns null|boolean.
     1092             * @return {null|boolean}
    10931093             */
    10941094            hasMore: function() {
  • trunk/src/js/_enqueues/wp/autosave.js

    r43347 r46800  
    2424     * @since 3.9.0
    2525     *
    26      * @returns {Object}
     26     * @return {Object}
    2727     *  {{
    2828     *      getPostData: getPostData,
     
    4747         * @param {string} type The type of autosave either local or remote.
    4848         *
    49          * @returns {Object} Object containing the post data.
     49         * @return {Object} Object containing the post data.
    5050         */
    5151        function getPostData( type ) {
     
    111111         * @param {Object} postData The object containing the post data.
    112112         *
    113          * @returns {string} A concatenated string with title, content and excerpt.
     113         * @return {string} A concatenated string with title, content and excerpt.
    114114         */
    115115        function getCompareString( postData ) {
     
    126126         * @since 3.9.0
    127127         *
    128          * @returns {void}
     128         * @return {void}
    129129         */
    130130        function disableButtons() {
     
    140140         * @since 3.9.0
    141141         *
    142          * @returns {void}
     142         * @return {void}
    143143         */
    144144        function enableButtons() {
     
    151151         * @since 4.6.0
    152152         *
    153          * @returns {boolean|*} Returns either false if the editor is undefined,
    154          *                      or the instance of the content editor.
     153         * @return {boolean|*} Returns either false if the editor is undefined,
     154         *                     or the instance of the content editor.
    155155         */
    156156        function getEditor() {
     
    163163         * @since 3.9.0
    164164         *
    165          * @returns {
     165         * @return {
    166166         * {
    167167         *  hasStorage: *,
     
    184184             * @since 3.9.0
    185185             *
    186              * @returns {boolean} True if the sessionStorage is supported and enabled.
     186             * @return {boolean} True if the sessionStorage is supported and enabled.
    187187             */
    188188            function checkStorage() {
     
    205205             * @since 3.9.0
    206206             *
    207              * @returns {boolean|Object} False if no sessionStorage in the browser or an Object
    208              *                           containing all postData for this blog.
     207             * @return {boolean|Object} False if no sessionStorage in the browser or an Object
     208             *                          containing all postData for this blog.
    209209             */
    210210            function getStorage() {
     
    230230             * @since 3.9.0
    231231             *
    232              * @returns {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.
    233233             */
    234234            function setStorage( stored_obj ) {
     
    249249             * @since 3.9.0
    250250             *
    251              * @returns {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.
    252252             */
    253253            function getSavedPostData() {
     
    270270             * @param {Object|boolean|null} stored_data The post data to store or null/false/empty to delete the key.
    271271             *
    272              * @returns {boolean} True if data is stored, false if data was removed.
     272             * @return {boolean} True if data is stored, false if data was removed.
    273273             */
    274274            function setData( stored_data ) {
     
    295295             * @since 3.9.0
    296296             *
    297              * @returns {void}
     297             * @return {void}
    298298             */
    299299            function suspend() {
     
    306306             * @since 3.9.0
    307307             *
    308              * @returns {void}
     308             * @return {void}
    309309             */
    310310            function resume() {
     
    322322             * @param {Object} data The post data for saving, minimum 'post_title' and 'content'.
    323323             *
    324              * @returns {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.
    325325             */
    326326            function save( data ) {
     
    371371             * @since 3.9.0
    372372             *
    373              * @returns {void}
     373             * @return {void}
    374374             */
    375375            function run() {
     
    428428             * @param {string} str1 The first string.
    429429             * @param {string} str2 The second string.
    430              * @returns {boolean} True if the strings are the same.
     430             * @return {boolean} True if the strings are the same.
    431431             */
    432432            function compare( str1, str2 ) {
     
    446446             * @since 3.9.0
    447447             *
    448              * @returns {void}
     448             * @return {void}
    449449             */
    450450            function checkPost() {
     
    514514             * @param {Object} postData The object containing all post data.
    515515             *
    516              * @returns {boolean} True if the post is restored.
     516             * @return {boolean} True if the post is restored.
    517517             */
    518518            function restorePost( postData ) {
     
    580580         * @since 3.9.0
    581581         *
    582          * @returns {Object} {
     582         * @return {Object} {
    583583         *  {
    584584         *      tempBlockSave: tempBlockSave,
     
    601601             * @since 3.9.0
    602602             *
    603              * @returns {void}
     603             * @return {void}
    604604             */
    605605            function tempBlockSave() {
     
    617617             * @since 3.9.0
    618618             *
    619              * @returns {void}
     619             * @return {void}
    620620             */
    621621            function suspend() {
     
    628628             * @since 3.9.0
    629629             *
    630              * @returns {void}
     630             * @return {void}
    631631             */
    632632            function resume() {
     
    641641             * @param {Object} data The post data.
    642642             *
    643              * @returns {void}
     643             * @return {void}
    644644             */
    645645            function response( data ) {
     
    665665             * @since 3.9.0
    666666             *
    667              * @returns {void}
     667             * @return {void}
    668668             */
    669669            function triggerSave() {
     
    694694             * @since 3.9.0
    695695             *
    696              * @returns {Object} Returns the post data.
     696             * @return {Object} Returns the post data.
    697697             */
    698698            function save() {
     
    740740             * @since 3.9.0
    741741             *
    742              * @returns {void}
     742             * @return {void}
    743743             */
    744744            function _schedule() {
     
    751751             * @since 3.9.0
    752752             *
    753              * @returns {void}
     753             * @return {void}
    754754             */
    755755            $document.on( 'heartbeat-send.autosave', function( event, data ) {
     
    766766                 * @since 3.9.0
    767767                 *
    768                  * @returns {void}
     768                 * @return {void}
    769769                 */
    770770            }).on( 'heartbeat-tick.autosave', function( event, data ) {
     
    777777                 * @since 3.9.0
    778778                 *
    779                  * @returns {void}
     779                 * @return {void}
    780780                 */
    781781            }).on( 'heartbeat-connection-lost.autosave', function( event, error, status ) {
     
    798798                 * @since 3.9.0
    799799                 *
    800                  * @returns {void}
     800                 * @return {void}
    801801                 */
    802802            }).on( 'heartbeat-connection-restored.autosave', function() {
     
    826826         * @since 3.9.0
    827827         *
    828          * @returns {void}
     828         * @return {void}
    829829         */
    830830        $document.on( 'tinymce-editor-init.autosave', function( event, editor ) {
  • trunk/src/js/_enqueues/wp/code-editor.js

    r46586 r46800  
    4545     * @param {Function}   settings.onUpdateErrorNotice - Callback to update error notice.
    4646     *
    47      * @returns {void}
     47     * @return {void}
    4848     */
    4949    function configureLinting( editor, settings ) { // eslint-disable-line complexity
     
    5353         * Call the onUpdateErrorNotice if there are new errors to show.
    5454         *
    55          * @returns {void}
     55         * @return {void}
    5656         */
    5757        function updateErrorNotice() {
     
    6565         * Get lint options.
    6666         *
    67          * @returns {object} Lint options.
     67         * @return {object} Lint options.
    6868         */
    6969        function getLintOptions() { // eslint-disable-line complexity
     
    215215     * @param {Function}   settings.onTabPrevious - Callback to handle tabbing to the previous tabbable element.
    216216     *
    217      * @returns {void}
     217     * @return {void}
    218218     */
    219219    function configureTabbing( codemirror, settings ) {
     
    274274     * @param {object}                [settings.jshint] - Rules for JSHint.
    275275     *
    276      * @returns {CodeEditorInstance} Instance.
     276     * @return {CodeEditorInstance} Instance.
    277277     */
    278278    wp.codeEditor.initialize = function initialize( textarea, settings ) {
  • trunk/src/js/_enqueues/wp/customize/base.js

    r43347 r46800  
    483483         *     when( id1, id2, id3, function( value1, value2, value3 ) {} );
    484484         *
    485          * @returns $.Deferred.promise();
     485         * @return $.Deferred.promise();
    486486         */
    487487        when: function() {
     
    877877         * @since 4.9.0
    878878         *
    879          * @returns {jQuery} Notification container element.
     879         * @return {jQuery} Notification container element.
    880880         */
    881881        render: function() {
     
    943943     *
    944944     * @param {string} queryString Query string.
    945      * @returns {object} Parsed query string.
     945     * @return {object} Parsed query string.
    946946     */
    947947    api.utils.parseQueryString = function parseQueryString( queryString ) {
  • trunk/src/js/_enqueues/wp/customize/controls.js

    r46799 r46800  
    5656         *
    5757         * @param {jQuery.Event} event - Event.
    58          * @returns {void}
     58         * @return {void}
    5959         */
    6060        handleEscape: function( event ) {
     
    9999         * @param {boolean} [options.alt] - Whether alternative style should be used when rendering notifications.
    100100         *
    101          * @returns {void}
     101         * @return {void}
    102102         */
    103103        initialize: function( options ) {
     
    138138         * @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.
    139139         * @param {wp.customize.Notification} [notificationObject] - Notification to add when first argument is the code string.
    140          * @returns {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).
    141141         */
    142142        add: function( notification, notificationObject ) {
     
    212212         *
    213213         * @since 4.9.0
    214          * @returns {void}
     214         * @return {void}
    215215         */
    216216        render: function() {
     
    305305         *
    306306         * @param {jQuery.Event} event - Event.
    307          * @returns {void}
     307         * @return {void}
    308308         */
    309309        constrainFocus: function constrainFocus( event ) {
     
    399399         * @access public
    400400         *
    401          * @returns {void}
     401         * @return {void}
    402402         */
    403403        preview: function() {
     
    420420         *
    421421         * @since 4.6.0
    422          * @returns {wp.customize.Control[]} Controls associated with setting.
     422         * @return {wp.customize.Control[]} Controls associated with setting.
    423423         */
    424424        findControls: function() {
     
    498498     * @param {object} [options] Options.
    499499     * @param {boolean} [options.unsaved=false] Whether only values not saved yet into a changeset will be returned (differential changes).
    500      * @returns {object} Dirty setting values.
     500     * @return {object} Dirty setting values.
    501501     */
    502502    api.dirtyValues = function dirtyValues( options ) {
     
    536536     * @param {string}  [args.title] - Title to update in the changeset. Optional.
    537537     * @param {string}  [args.date] - Date to update in the changeset. Optional.
    538      * @returns {jQuery.Promise} Promise resolving with the response data.
     538     * @return {jQuery.Promise} Promise resolving with the response data.
    539539     */
    540540    api.requestChangesetUpdate = function requestChangesetUpdate( changes, args ) {
     
    736736     * @param {(wp.customize.Panel|wp.customize.Section|wp.customize.Control)} a
    737737     * @param {(wp.customize.Panel|wp.customize.Section|wp.customize.Control)} b
    738      * @returns {Number}
     738     * @return {Number}
    739739     */
    740740    api.utils.prioritySort = function ( a, b ) {
     
    754754     *
    755755     * @param {jQuery.Event} event
    756      * @returns {boolean}
     756     * @return {boolean}
    757757     */
    758758    api.utils.isKeydownButNotEnterEvent = function ( event ) {
     
    769769     * @param {Array|jQuery} listA
    770770     * @param {Array|jQuery} listB
    771      * @returns {boolean}
     771     * @return {boolean}
    772772     */
    773773    api.utils.areElementListsEqual = function ( listA, listB ) {
     
    803803     *                                         containing auxiliary UI, such as the Publish button augmented with a
    804804     *                                         Settings button.
    805      * @returns {Function} An idempotent function that cancels the reminder.
     805     * @return {Function} An idempotent function that cancels the reminder.
    806806     */
    807807    api.utils.highlightButton = function highlightButton( button, options ) {
     
    850850     * @since 4.9.0
    851851     *
    852      * @returns {int} Current timestamp.
     852     * @return {int} Current timestamp.
    853853     */
    854854    api.utils.getCurrentTimestamp = function getCurrentTimestamp() {
     
    894894     * @ignore
    895895     *
    896      * @returns {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.
    897897     */
    898898    normalizedTransitionendEventName = (function () {
     
    10151015         *
    10161016         * @since 4.9.0
    1017          * @returns {jQuery} Notification container element.
     1017         * @return {jQuery} Notification container element.
    10181018         */
    10191019        getNotificationsContainerElement: function() {
     
    10261026         *
    10271027         * @since 4.9.0
    1028          * @returns {void}
     1028         * @return {void}
    10291029         */
    10301030        setupNotifications: function() {
     
    10571057         * @param {String} parentType
    10581058         * @param {String} childType
    1059          * @returns {Array}
     1059         * @return {Array}
    10601060         */
    10611061        _children: function ( parentType, childType ) {
     
    11551155         * @param {Boolean} active
    11561156         * @param {Object}  [params]
    1157          * @returns {Boolean} False if state already applied.
     1157         * @return {Boolean} False if state already applied.
    11581158         */
    11591159        _toggleActive: function ( active, params ) {
     
    11741174        /**
    11751175         * @param {Object} [params]
    1176          * @returns {Boolean} False if already active.
     1176         * @return {Boolean} False if already active.
    11771177         */
    11781178        activate: function ( params ) {
     
    11821182        /**
    11831183         * @param {Object} [params]
    1184          * @returns {Boolean} False if already inactive.
     1184         * @return {Boolean} False if already inactive.
    11851185         */
    11861186        deactivate: function ( params ) {
     
    12021202         * @param {Object}   [params] - Object containing options for expand/collapse.
    12031203         * @param {Function} [params.completeCallback] - Function to call when expansion/collapse is complete.
    1204          * @returns {Boolean} False if state already applied or active state is false.
     1204         * @return {Boolean} False if state already applied or active state is false.
    12051205         */
    12061206        _toggleExpanded: function( expanded, params ) {
     
    12391239        /**
    12401240         * @param {Object} [params]
    1241          * @returns {Boolean} False if already expanded or if inactive.
     1241         * @return {Boolean} False if already expanded or if inactive.
    12421242         */
    12431243        expand: function ( params ) {
     
    12471247        /**
    12481248         * @param {Object} [params]
    1249          * @returns {Boolean} False if already collapsed.
     1249         * @return {Boolean} False if already collapsed.
    12501250         */
    12511251        collapse: function ( params ) {
     
    12601260         *
    12611261         * @param {function} completeCallback Function to be called after transition is completed.
    1262          * @returns {void}
     1262         * @return {void}
    12631263         */
    12641264        _animateChangeExpanded: function( completeCallback ) {
     
    13631363         * @access public
    13641364         *
    1365          * @returns {jQuery} Detached content element.
     1365         * @return {jQuery} Detached content element.
    13661366         */
    13671367        getContent: function() {
     
    15441544         * @since 4.1.0
    15451545         *
    1546          * @returns {Boolean}
     1546         * @return {Boolean}
    15471547         */
    15481548        isContextuallyActive: function () {
     
    15631563         * @since 4.1.0
    15641564         *
    1565          * @returns {Array}
     1565         * @return {Array}
    15661566         */
    15671567        controls: function () {
     
    16971697         * @param {string} id - ID.
    16981698         * @param {object} options - Options.
    1699          * @returns {void}
     1699         * @return {void}
    17001700         */
    17011701        initialize: function( id, options ) {
     
    17461746         * @since 4.2.0
    17471747         *
    1748          * @returns {void}
     1748         * @return {void}
    17491749         */
    17501750        ready: function() {
     
    17981798         * @since 4.2.0
    17991799         *
    1800          * @returns {Boolean}
     1800         * @return {Boolean}
    18011801         */
    18021802        isContextuallyActive: function () {
     
    18091809         * @since 4.2.0
    18101810         *
    1811          * @returns {void}
     1811         * @return {void}
    18121812         */
    18131813        attachEvents: function () {
     
    19541954         * @param {Boolean}  args.unchanged
    19551955         * @param {Function} args.completeCallback
    1956          * @returns {void}
     1956         * @return {void}
    19571957         */
    19581958        onChangeExpanded: function ( expanded, args ) {
     
    20442044         * @since 4.9.0
    20452045         *
    2046          * @returns {jQuery}
     2046         * @return {jQuery}
    20472047         */
    20482048        getContent: function() {
     
    20552055         * @since 4.9.0
    20562056         *
    2057          * @returns {void}
     2057         * @return {void}
    20582058         */
    20592059        loadThemes: function() {
     
    21662166         * @param {Array} themes - Array of theme data to create controls with.
    21672167         * @param {integer} page - Page of results being loaded.
    2168          * @returns {void}
     2168         * @return {void}
    21692169         */
    21702170        loadControls: function( themes, page ) {
     
    21952195         *
    21962196         * @since 4.9.0
    2197          * @returns {void}
     2197         * @return {void}
    21982198         */
    21992199        loadMore: function() {
     
    22172217         *
    22182218         * @param {string} term - The raw search input value.
    2219          * @returns {void}
     2219         * @return {void}
    22202220         */
    22212221        filterSearch: function( term ) {
     
    22612261         *
    22622262         * @param {wp.customize.ThemesSection} section - The current theme section, passed through the debouncer.
    2263          * @returns {void}
     2263         * @return {void}
    22642264         */
    22652265        checkTerm: function( section ) {
     
    22782278         * @since 4.9.0
    22792279         *
    2280          * @returns {void}
     2280         * @return {void}
    22812281         */
    22822282        filtersChecked: function() {
     
    23212321         * @param {string} newTerm - New term.
    23222322         * @param {Array} newTags - New tags.
    2323          * @returns {void}
     2323         * @return {void}
    23242324         */
    23252325        initializeNewQuery: function( newTerm, newTags ) {
     
    23542354         * @since 4.2.0
    23552355         *
    2356          * @returns {void}
     2356         * @return {void}
    23572357         */
    23582358        renderScreenshots: function() {
     
    24082408         * @since 4.9.0
    24092409         *
    2410          * @returns {int} Visible count.
     2410         * @return {int} Visible count.
    24112411         */
    24122412        getVisibleCount: function() {
     
    24192419         * @since 4.9.0
    24202420         *
    2421          * @returns {void}
     2421         * @return {void}
    24222422         */
    24232423        updateCount: function( count ) {
     
    24492449         * @since 4.2.0
    24502450         *
    2451          * @returns {void}
     2451         * @return {void}
    24522452         */
    24532453        nextTheme: function () {
     
    24652465         * @since 4.2.0
    24662466         *
    2467          * @returns {wp.customize.ThemeControl|boolean} Next theme.
     2467         * @return {wp.customize.ThemeControl|boolean} Next theme.
    24682468         */
    24692469        getNextTheme: function () {
     
    24872487         *
    24882488         * @since 4.2.0
    2489          * @returns {void}
     2489         * @return {void}
    24902490         */
    24912491        previousTheme: function () {
     
    25022502         *
    25032503         * @since 4.2.0
    2504          * @returns {wp.customize.ThemeControl|boolean} Previous theme.
     2504         * @return {wp.customize.ThemeControl|boolean} Previous theme.
    25052505         */
    25062506        getPreviousTheme: function () {
     
    25252525         * @since 4.2.0
    25262526         *
    2527          * @returns {void}
     2527         * @return {void}
    25282528         */
    25292529        updateLimits: function () {
     
    25442544         * @deprecated
    25452545         * @param {string} themeId Theme ID.
    2546          * @returns {jQuery.promise} Promise.
     2546         * @return {jQuery.promise} Promise.
    25472547         */
    25482548        loadThemePreview: function( themeId ) {
     
    25572557         * @param {object} theme - Theme.
    25582558         * @param {Function} [callback] - Callback once the details have been shown.
    2559          * @returns {void}
     2559         * @return {void}
    25602560         */
    25612561        showDetails: function ( theme, callback ) {
     
    25922592         * @since 4.2.0
    25932593         *
    2594          * @returns {void}
     2594         * @return {void}
    25952595         */
    25962596        closeDetails: function () {
     
    26072607         *
    26082608         * @param {jQuery} el - Element to contain focus.
    2609          * @returns {void}
     2609         * @return {void}
    26102610         */
    26112611        containFocus: function( el ) {
     
    26482648         * @since 4.9.0
    26492649         *
    2650          * @returns {void}
     2650         * @return {void}
    26512651         */
    26522652        initialize: function() {
     
    28712871         * @since 4.1.0
    28722872         *
    2873          * @returns {Array}
     2873         * @return {Array}
    28742874         */
    28752875        sections: function () {
     
    28822882         * @since 4.1.0
    28832883         *
    2884          * @returns {boolean} Whether contextually active.
     2884         * @return {boolean} Whether contextually active.
    28852885         */
    28862886        isContextuallyActive: function () {
     
    29052905         * @param {Boolean}  args.unchanged
    29062906         * @param {Function} args.completeCallback
    2907          * @returns {void}
     2907         * @return {void}
    29082908         */
    29092909        onChangeExpanded: function ( expanded, args ) {
     
    30333033         * @param {string} id - The ID for the panel.
    30343034         * @param {object} options - Options.
    3035          * @returns {void}
     3035         * @return {void}
    30363036         */
    30373037        initialize: function( id, options ) {
     
    30473047         *
    30483048         * @param {string} [slug] - Theme slug.
    3049          * @returns {boolean} Whether the theme can be switched to.
     3049         * @return {boolean} Whether the theme can be switched to.
    30503050         */
    30513051        canSwitchTheme: function canSwitchTheme( slug ) {
     
    30603060         *
    30613061         * @since 4.9.0
    3062          * @returns {void}
     3062         * @return {void}
    30633063         */
    30643064        attachEvents: function() {
     
    31333133         * @param {Boolean}  args.unchanged - Whether or not the state changed.
    31343134         * @param {Function} args.completeCallback - Callback to execute when the animation completes.
    3135          * @returns {void}
     3135         * @return {void}
    31363136         */
    31373137        onChangeExpanded: function( expanded, args ) {
     
    31853185         *
    31863186         * @param {jQuery.Event} event - Event.
    3187          * @returns {jQuery.promise} Promise.
     3187         * @return {jQuery.promise} Promise.
    31883188         */
    31893189        installTheme: function( event ) {
     
    32903290         *
    32913291         * @param {string} themeId Theme ID.
    3292          * @returns {jQuery.promise} Promise.
     3292         * @return {jQuery.promise} Promise.
    32933293         */
    32943294        loadThemePreview: function( themeId ) {
     
    33663366         *
    33673367         * @param {jQuery.Event} event - Event.
    3368          * @returns {void}
     3368         * @return {void}
    33693369         */
    33703370        updateTheme: function( event ) {
     
    33963396         *
    33973397         * @param {jQuery.Event} event - Event.
    3398          * @returns {void}
     3398         * @return {void}
    33993399         */
    34003400        deleteTheme: function( event ) {
     
    34933493         * @param {number} [options.instanceNumber] - Order in which this instance was created in relation to other instances.
    34943494         * @param {object} [options.params]         - Deprecated wrapper for the above properties.
    3495          * @returns {void}
     3495         * @return {void}
    34963496         */
    34973497        initialize: function( id, options ) {
     
    36343634         * @access public
    36353635         *
    3636          * @returns {void}
     3636         * @return {void}
    36373637         */
    36383638        linkElements: function () {
     
    37093709         * Triggered when the control's markup has been injected into the DOM.
    37103710         *
    3711          * @returns {void}
     3711         * @return {void}
    37123712         */
    37133713        ready: function() {
     
    37403740         *
    37413741         * @since 4.6.0
    3742          * @returns {jQuery} Setting validation message element.
     3742         * @return {jQuery} Setting validation message element.
    37433743         */
    37443744        getNotificationsContainerElement: function() {
     
    37713771         *
    37723772         * @since 4.9.0
    3773          * @returns {void}
     3773         * @return {void}
    37743774         */
    37753775        setupNotifications: function() {
     
    40484048         * @since 4.7.0
    40494049         * @access private
    4050          * @returns {void}
     4050         * @return {void}
    40514051         */
    40524052        addNewPage: function () {
     
    45714571         * @param {wp.media.model.Attachment} attachment
    45724572         * @param {wp.media.controller.Cropper} controller
    4573          * @returns {Object} Options
     4573         * @return {Object} Options
    45744574         */
    45754575        calculateImageSelectOptions: function( attachment, controller ) {
     
    48544854         * @since 4.2.0
    48554855         *
    4856          * @returns {Object} Options
     4856         * @return {Object} Options
    48574857         */
    48584858        getInitialHeaderImage: function() {
     
    48874887         * @param {wp.media.model.Attachment} attachment
    48884888         * @param {wp.media.controller.Cropper} controller
    4889          * @returns {Object} Options
     4889         * @return {Object} Options
    48904890         */
    48914891        calculateImageSelectOptions: function(attachment, controller) {
     
    51565156         * @since 4.2.0
    51575157         * @param {Array} terms - An array of terms to search for.
    5158          * @returns {boolean} Whether a theme control was activated or not.
     5158         * @return {boolean} Whether a theme control was activated or not.
    51595159         */
    51605160        filter: function( terms ) {
     
    52085208         * @since 4.9.0
    52095209         *
    5210          * @returns {void}
     5210         * @return {void}
    52115211         */
    52125212        rerenderAsInstalled: function( installed ) {
     
    52395239         * @param {string} id      - Unique identifier for the control instance.
    52405240         * @param {object} options - Options hash for the control instance.
    5241          * @returns {void}
     5241         * @return {void}
    52425242         */
    52435243        initialize: function( id, options ) {
     
    52745274         *
    52755275         * @since 4.9.0
    5276          * @returns {void}
     5276         * @return {void}
    52775277         */
    52785278        ready: function() {
     
    53065306         *
    53075307         * @since 4.9.0
    5308          * @returns {void}
     5308         * @return {void}
    53095309         */
    53105310        initEditor: function() {
     
    53575357         * @param {Object}   [params] - Focus params.
    53585358         * @param {Function} [params.completeCallback] - Function to call when expansion is complete.
    5359          * @returns {void}
     5359         * @return {void}
    53605360         */
    53615361        focus: function( params ) {
     
    53785378         * @since 4.9.0
    53795379         * @param {object} codeEditorSettings - Code editor settings.
    5380          * @returns {void}
     5380         * @return {void}
    53815381         */
    53825382        initSyntaxHighlightingEditor: function( codeEditorSettings ) {
     
    54375437         *
    54385438         * @since 4.9.0
    5439          * @returns {void}
     5439         * @return {void}
    54405440         */
    54415441        onTabNext: function onTabNext() {
     
    54555455         *
    54565456         * @since 4.9.0
    5457          * @returns {void}
     5457         * @return {void}
    54585458         */
    54595459        onTabPrevious: function onTabPrevious() {
     
    54745474         * @since 4.9.0
    54755475         * @param {Array} errorAnnotations - Error annotations.
    5476          * @returns {void}
     5476         * @return {void}
    54775477         */
    54785478        onUpdateErrorNotice: function onUpdateErrorNotice( errorAnnotations ) {
     
    54975497         *
    54985498         * @since 4.9.0
    5499          * @returns {void}
     5499         * @return {void}
    55005500         */
    55015501        initPlainTextareaEditor: function() {
     
    55575557         *
    55585558         * @since 4.9.0
    5559          * @returns {void}
     5559         * @return {void}
    55605560         */
    55615561        ready: function ready() {
     
    56195619         *
    56205620         * @param {string} datetime - Date/Time string. Accepts Y-m-d[ H:i[:s]] format.
    5621          * @returns {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.
    56225622         */
    56235623        parseDateTime: function parseDateTime( datetime ) {
     
    57345734         *
    57355735         * @since 4.9.0
    5736          * @returns {boolean} If setting updated.
     5736         * @return {boolean} If setting updated.
    57375737         */
    57385738        populateSetting: function populateSetting() {
     
    57955795         *
    57965796         * @since 4.9.0
    5797          * @returns {boolean} True if future date.
     5797         * @return {boolean} True if future date.
    57985798         */
    57995799        isFutureDate: function isFutureDate() {
     
    58085808         * @param {string} hourInTwelveHourFormat - Hour in twelve hour format.
    58095809         * @param {string} meridian - Either 'am' or 'pm'.
    5810          * @returns {string} Hour in twenty four hour format.
     5810         * @return {string} Hour in twenty four hour format.
    58115811         */
    58125812        convertHourToTwentyFourHourFormat: function convertHour( hourInTwelveHourFormat, meridian ) {
     
    58335833         *
    58345834         * @since 4.9.0
    5835          * @returns {boolean} Whether the inputs were populated.
     5835         * @return {boolean} Whether the inputs were populated.
    58365836         */
    58375837        populateDateInputs: function populateDateInputs() {
     
    59155915         *
    59165916         * @since 4.9.0
    5917          * @returns {void}
     5917         * @return {void}
    59185918         */
    59195919        ready: function ready() {
     
    60436043     * @param {...string} ids - One or more ids for controls to obtain.
    60446044     * @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.
    60466047     *
    60476048     * @example <caption>Loop over all registered controls.</caption>
     
    61046105     * @param {...string} ids - One or more ids for sections to obtain.
    61056106     * @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.
    61076109     *
    61086110     * @example <caption>Loop over all registered sections.</caption>
     
    61386140     * @param {...string} ids - One or more ids for panels to obtain.
    61396141     * @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.
    61416144     *
    61426145     * @example <caption>Loop over all registered panels.</caption>
     
    61726175     * @param {...string} codes - One or more codes for notifications to obtain.
    61736176     * @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.
    61756179     *
    61766180     * @example <caption>Check if existing notification</caption>
     
    66016605         * @param {object} data.activeSections Active sections.
    66026606         * @param {object} data.activeControls Active controls.
    6603          * @returns {void}
     6607         * @return {void}
    66046608         */
    66056609        ready: function( data ) {
     
    66716675         * @access public
    66726676         *
    6673          * @returns {void}
     6677         * @return {void}
    66746678         */
    66756679        keepPreviewAlive: function keepPreviewAlive() {
     
    67326736         * @since 3.4.0
    67336737         * @access public
    6734          * @returns {void}
     6738         * @return {void}
    67356739         */
    67366740        refresh: function() {
     
    69066910     * @param {object}  args.settingValidities
    69076911     * @param {boolean} [args.focusInvalidControl=false]
    6908      * @returns {void}
     6912     * @return {void}
    69096913     */
    69106914    api._handleSettingValidities = function handleSettingValidities( args ) {
     
    69796983     * @since 4.6.0
    69806984     * @param {string[]} settingIds Setting IDs.
    6981      * @returns {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.
    69826986     */
    69836987    api.findControlsForSettings = function findControlsForSettings( settingIds ) {
     
    74277431             * @param {string} [args.date] Date, in local time in MySQL format.
    74287432             * @param {string} [args.title] Title
    7429              * @returns {jQuery.promise} Promise.
     7433             * @return {jQuery.promise} Promise.
    74307434             */
    74317435            save: function( args ) {
     
    77007704             * @since 4.9.0
    77017705             *
    7702              * @returns {jQuery.promise} Promise.
     7706             * @return {jQuery.promise} Promise.
    77037707             */
    77047708            trash: function trash() {
     
    80348038             *
    80358039             * @param {boolean} isIncluded Is UUID included.
    8036              * @returns {void}
     8040             * @return {void}
    80378041             */
    80388042            populateChangesetUuidParam = function( isIncluded ) {
     
    81938197             * @param {object} [args.lockUser] - Lock user data.
    81948198             * @param {boolean} [args.allowOverride=false] - Whether override is allowed.
    8195              * @returns {void}
     8199             * @return {void}
    81968200             */
    81978201            function startLock( args ) {
     
    82528256             * Obtain the URL to restore the autosave.
    82538257             *
    8254              * @returns {string} Customizer URL.
     8258             * @return {string} Customizer URL.
    82558259             */
    82568260            function getAutosaveRestorationUrl() {
     
    82738277             *
    82748278             * @param {Array} params - Parameter names to remove.
    8275              * @returns {void}
     8279             * @return {void}
    82768280             */
    82778281            function stripParamsFromLocation( params ) {
     
    82968300             * Dismiss autosave.
    82978301             *
    8298              * @returns {void}
     8302             * @return {void}
    82998303             */
    83008304            function dismissAutosave() {
     
    83158319             * Add notification regarding the availability of an autosave to restore.
    83168320             *
    8317              * @returns {void}
     8321             * @return {void}
    83188322             */
    83198323            function addAutosaveRestoreNotification() {
     
    84938497             *
    84948498             * @param {wp.customize.Panel|wp.customize.Section} container Construct.
    8495              * @returns {void}
     8499             * @return {void}
    84968500             */
    84978501            changeContainer = function( container ) {
     
    86058609             * @access private
    86068610             *
    8607              * @returns {void}
     8611             * @return {void}
    86088612             */
    86098613            updateHeaderHeight = function() {
     
    86208624             * @param {number} scrollTop - Scroll top.
    86218625             * @param {number} scrollDirection - Scroll direction, negative number being up and positive being down.
    8622              * @returns {void}
     8626             * @return {void}
    86238627             */
    86248628            positionStickyHeader = function( header, scrollTop, scrollDirection ) {
  • trunk/src/js/_enqueues/wp/customize/nav-menus.js

    r46799 r46800  
    388388         * @param {Array.<object>} itemTypes List of objects containing type and key.
    389389         * @param {string} deprecated Formerly the object parameter.
    390          * @returns {void}
     390         * @return {void}
    391391         */
    392392        loadItems: function( itemTypes, deprecated ) {
     
    596596         *
    597597         * @param {jQuery.Event} event Event.
    598          * @returns {void}
     598         * @return {void}
    599599         */
    600600        _submitNew: function( event ) {
     
    622622         *
    623623         * @param {jQuery} container
    624          * @returns {void}
     624         * @return {void}
    625625         */
    626626        submitNew: function( container ) {
     
    844844         * @private
    845845         *
    846          * @returns {void}
     846         * @return {void}
    847847         */
    848848        saveManageColumnsState: _.debounce( function() {
     
    878878         * @private
    879879         *
    880          * @returns {Array} Fields (columns) that are hidden.
     880         * @return {Array} Fields (columns) that are hidden.
    881881         */
    882882        hidden: function() {
     
    974974             *
    975975             * @this {jQuery}
    976              * @returns {void}
     976             * @return {void}
    977977             */
    978978            handleFieldActiveToggle = function() {
     
    11671167         * @since 4.9.0
    11681168         *
    1169          * @returns {void}
     1169         * @return {void}
    11701170         */
    11711171        highlightNewItemButton: function() {
     
    11801180     *
    11811181     * @param {string} [name=''] Nav menu name.
    1182      * @returns {wp.customize.Menus.MenuSection} Added nav menu.
     1182     * @return {wp.customize.Menus.MenuSection} Added nav menu.
    11831183     */
    11841184    api.Menus.createNavMenu = function createNavMenu( name ) {
     
    12641264             *
    12651265             * @since 4.9.0
    1266              * @returns {number} Count.
     1266             * @return {number} Count.
    12671267             */
    12681268            function getNavMenuCount() {
     
    12801280             *
    12811281             * @since 4.9.0
    1282              * @returns {void}
     1282             * @return {void}
    12831283             */
    12841284            function updateNoticeVisibility() {
     
    12911291             * @since 4.9.0
    12921292             * @param {wp.customize.Setting} setting - Added setting.
    1293              * @returns {void}
     1293             * @return {void}
    12941294             */
    12951295            function addChangeEventListener( setting ) {
     
    13051305             * @since 4.9.0
    13061306             * @param {wp.customize.Setting} setting - Removed setting.
    1307              * @returns {void}
     1307             * @return {void}
    13081308             */
    13091309            function removeChangeEventListener( setting ) {
     
    14401440         *
    14411441         * @param {string|null} locationId - The ID of the location to select. `null` clears all selections.
    1442          * @returns {void}
     1442         * @return {void}
    14431443         */
    14441444        selectDefaultLocation: function( locationId ) {
     
    18711871        /**
    18721872         *
    1873          * @returns {number}
     1873         * @return {number}
    18741874         */
    18751875        getDepth: function() {
     
    19631963         * @param {Boolean} expanded
    19641964         * @param {Object} [params]
    1965          * @returns {Boolean} False if state already applied.
     1965         * @return {Boolean} False if state already applied.
    19661966         */
    19671967        _toggleExpanded: api.Section.prototype._toggleExpanded,
     
    19711971         *
    19721972         * @param {Object} [params]
    1973          * @returns {Boolean} False if already expanded.
     1973         * @return {Boolean} False if already expanded.
    19741974         */
    19751975        expand: api.Section.prototype.expand,
     
    19911991         *
    19921992         * @param {Object} [params]
    1993          * @returns {Boolean} False if already collapsed.
     1993         * @return {Boolean} False if already collapsed.
    19941994         */
    19951995        collapse: api.Section.prototype.collapse,
     
    24292429         *
    24302430         * @param {Object.<string,boolean>} selections - A map of location selections.
    2431          * @returns {void}
     2431         * @return {void}
    24322432         */
    24332433        setSelections: function( selections ) {
     
    29552955         *
    29562956         * @param {object} item - Value for the nav_menu_item setting to be created.
    2957          * @returns {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.
    29582958         */
    29592959        addItemToMenu: function( item ) {
     
    33743374     *
    33753375     * @param {string} name
    3376      * @returns {string}
     3376     * @return {string}
    33773377     */
    33783378    function displayNavMenuName( name ) {
  • trunk/src/js/_enqueues/wp/customize/preview-nav-menus.js

    r43347 r46800  
    135135             * @param {number|object|false|null}  newValue - New value, or null if the setting was just removed.
    136136             * @param {number|object|false|null}  oldValue - Old value, or null if the setting was just added.
    137              * @returns {boolean}
     137             * @return {boolean}
    138138             */
    139139            isRelatedSetting: function( setting, newValue, oldValue ) {
     
    211211             * @since 4.5.0
    212212             *
    213              * @returns {Promise}
     213             * @return {Promise}
    214214             */
    215215            refresh: function() {
  • trunk/src/js/_enqueues/wp/customize/preview-widgets.js

    r43347 r46800  
    1717 * @param {Object} api Information from the API.
    1818 *
    19  * @returns {Object} Widget-related variables.
     19 * @return {Object} Widget-related variables.
    2020 */
    2121wp.customize.widgetsPreview = wp.customize.WidgetCustomizerPreview = (function( $, _, wp, api ) {
     
    4343     * @memberOf wp.customize.widgetsPreview
    4444     *
    45      * @returns {void}
     45     * @return {void}
    4646     */
    4747    self.init = function() {
     
    125125         * @since 4.5.0
    126126         *
    127          * @returns {Promise|void} Either a promise postponing the refresh, or void.
     127         * @return {Promise|void} Either a promise postponing the refresh, or void.
    128128         */
    129129        refresh: function() {
     
    147147         *                                                            function.
    148148         *
    149          * @returns {void}
     149         * @return {void}
    150150         */
    151151        renderContent: function( placement ) {
     
    206206         * @since 4.5.0
    207207         *
    208          * @returns {void}
     208         * @return {void}
    209209         */
    210210        ready: function() {
     
    252252         * @since 4.5.0
    253253         *
    254          * @returns {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.
     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.
    257257         */
    258258        findDynamicSidebarBoundaryNodes: function() {
     
    294294         * @since 4.5.0
    295295         *
    296          * @returns {Array} An array containing placement objects for each of the
    297          *                  dynamic sidebar boundary nodes.
     296         * @return {Array} An array containing placement objects for each of the
     297         *                 dynamic sidebar boundary nodes.
    298298         */
    299299        placements: function() {
     
    321321         * @throws {Error} If the API doesn't pass an array of widget ids.
    322322         *
    323          * @returns {Array} A shallow copy of the array containing widget IDs.
     323         * @return {Array} A shallow copy of the array containing widget IDs.
    324324         */
    325325        getWidgetIds: function() {
     
    345345         * @since 4.5.0
    346346         *
    347          * @returns {Array.<wp.customize.selectiveRefresh.Placement>} List of placements
    348          *                                                            that were reflowed.
     347         * @return {Array.<wp.customize.selectiveRefresh.Placement>} List of placements
     348         *                                                           that were reflowed.
    349349         */
    350350        reflowWidgets: function() {
     
    413413         * @param {string} widgetId The widget ID.
    414414         *
    415          * @returns {wp.customize.selectiveRefresh.Partial} The widget instance partial.
     415         * @return {wp.customize.selectiveRefresh.Partial} The widget instance partial.
    416416         */
    417417        ensureWidgetPlacementContainers: function( widgetId ) {
     
    481481         * @param {Array} oldWidgetIds Old widget IDs.
    482482         *
    483          * @returns {void}
     483         * @return {void}
    484484         */
    485485        handleSettingChange: function( newWidgetIds, oldWidgetIds ) {
     
    536536         * @since 4.5.0
    537537         *
    538          * @returns {Promise} A promise postponing the refresh.
     538         * @return {Promise} A promise postponing the refresh.
    539539         */
    540540        refresh: function() {
     
    566566     * @since 4.5.0
    567567     *
    568      * @returns {void}
     568     * @return {void}
    569569     */
    570570    self.addPartials = function() {
     
    591591     * @since 3.9.0
    592592     *
    593      * @returns {void}
     593     * @return {void}
    594594     */
    595595    self.buildWidgetSelectors = function() {
     
    634634     * @param  {string} widgetId ID of the widget.
    635635     *
    636      * @returns {void}
     636     * @return {void}
    637637     */
    638638    self.highlightWidget = function( widgetId ) {
     
    656656     * @since 3.9.0
    657657     *
    658      * @returns {void}
     658     * @return {void}
    659659     */
    660660    self.highlightControls = function() {
     
    693693     * @param {string} widgetId The widget ID.
    694694     *
    695      * @returns {{idBase: string, number: number|null}} An object containing the
    696      *          idBase and 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.
    697697     */
    698698    self.parseWidgetId = function( widgetId ) {
     
    722722     * @param {string} settingId Widget setting ID.
    723723     *
    724      * @returns {{idBase: string, number: number|null}|null} Either an object
    725      *          containing the idBase and number of the parsed widget setting ID, or
    726      *          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.
    727727     */
    728728    self.parseWidgetSettingId = function( settingId ) {
     
    752752     * @param {string} widgetId The widget ID.
    753753     *
    754      * @returns {string} The setting ID.
     754     * @return {string} The setting ID.
    755755     */
    756756    self.getWidgetSettingId = function( widgetId ) {
  • trunk/src/js/_enqueues/wp/customize/preview.js

    r44684 r46800  
    2929         *
    3030         * @param {string} url URL.
    31          * @returns {string} URL with customized state.
     31         * @return {string} URL with customized state.
    3232         */
    3333        injectUrlWithState = function( url ) {
     
    235235     *
    236236     * @access private
    237      * @returns {void}
     237     * @return {void}
    238238     */
    239239    api.addLinkPreviewing = function addLinkPreviewing() {
     
    279279     * @param {object} [options]
    280280     * @param {object} [options.allowAdminAjax=false] Allow admin-ajax.php requests.
    281      * @returns {boolean} Is appropriate for changeset link.
     281     * @return {boolean} Is appropriate for changeset link.
    282282     */
    283283    api.isLinkPreviewable = function isLinkPreviewable( element, options ) {
     
    333333     * @param {string} element.host Host.
    334334     * @param {string} element.protocol Protocol.
    335      * @returns {void}
     335     * @return {void}
    336336     */
    337337    api.prepareLinkPreview = function prepareLinkPreview( element ) {
     
    405405         * @param {object} originalOptions Original options.
    406406         * @param {XMLHttpRequest} xhr XHR.
    407          * @returns {void}
     407         * @return {void}
    408408         */
    409409        var prefilterAjax = function( options, originalOptions, xhr ) {
     
    471471     * @access protected
    472472     *
    473      * @returns {void}
     473     * @return {void}
    474474     */
    475475    api.addFormPreviewing = function addFormPreviewing() {
     
    503503     *
    504504     * @param {HTMLFormElement} form Form.
    505      * @returns {void}
     505     * @return {void}
    506506     */
    507507    api.prepareFormPreview = function prepareFormPreview( form ) {
     
    627627         *
    628628         * @param {number} attachmentId Attachment ID for custom logo.
    629          * @returns {void}
     629         * @return {void}
    630630         */
    631631        custom_logo: function( attachmentId ) {
     
    637637         *
    638638         * @param {string} value Custom CSS..
    639          * @returns {void}
     639         * @return {void}
    640640         */
    641641        custom_css: function( value ) {
     
    646646         * Preview changes to any of the background settings.
    647647         *
    648          * @returns {void}
     648         * @return {void}
    649649         */
    650650        background: function() {
     
    776776         *
    777777         * @param {string} uuid - UUID.
    778          * @returns {void}
     778         * @return {void}
    779779         */
    780780        handleUpdatedChangesetUuid = function( uuid ) {
  • trunk/src/js/_enqueues/wp/customize/selective-refresh.js

    r46586 r46800  
    121121         *
    122122         * @param {Placement} placement The placement container element.
    123          * @returns {void}
     123         * @return {void}
    124124         */
    125125        createEditShortcutForPlacement: function( placement ) {
     
    151151         * @param {Placement} placement The placement for the partial.
    152152         * @param {jQuery} $editShortcut The shortcut element as a jQuery object.
    153          * @returns {void}
     153         * @return {void}
    154154         */
    155155        addEditShortcutToPlacement: function( placement, $editShortcut ) {
     
    409409         * @param {string|object|boolean} placement.addedContent - Rendered HTML content, a data object for JS templates to render, or false if no render.
    410410         * @param {object}                [placement.context]    - Optional context information about the container.
    411          * @returns {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.
    412412         */
    413413        renderContent: function( placement ) {
  • trunk/src/js/_enqueues/wp/customize/widgets.js

    r46799 r46800  
    10401040         *
    10411041         * @param {jQuery} container element in which to look for inputs
    1042          * @returns {jQuery} inputs
     1042         * @return {jQuery} inputs
    10431043         * @private
    10441044         */
     
    10521052         *
    10531053         * @param {jQuery} inputs
    1054          * @returns {string}
     1054         * @return {string}
    10551055         * @private
    10561056         */
     
    10751075         *
    10761076         * @param {jQuery|Element} input
    1077          * @returns {string|boolean|array|*}
     1077         * @return {string|boolean|array|*}
    10781078         * @private
    10791079         */
     
    13411341         * @param {Boolean} expanded
    13421342         * @param {Object} [params]
    1343          * @returns {Boolean} False if state already applied.
     1343         * @return {Boolean} False if state already applied.
    13441344         */
    13451345        _toggleExpanded: api.Section.prototype._toggleExpanded,
     
    13491349         *
    13501350         * @param {Object} [params]
    1351          * @returns {Boolean} False if already expanded.
     1351         * @return {Boolean} False if already expanded.
    13521352         */
    13531353        expand: api.Section.prototype.expand,
     
    13661366         *
    13671367         * @param {Object} [params]
    1368          * @returns {Boolean} False if already collapsed.
     1368         * @return {Boolean} False if already collapsed.
    13691369         */
    13701370        collapse: api.Section.prototype.collapse,
     
    14961496         * Get the position (index) of the widget in the containing sidebar
    14971497         *
    1498          * @returns {Number}
     1498         * @return {Number}
    14991499         */
    15001500        getWidgetSidebarPosition: function() {
     
    16531653                 * Update the notice.
    16541654                 *
    1655                  * @returns {void}
     1655                 * @return {void}
    16561656                 */
    16571657                updateNotice = function() {
     
    17091709         * @since 4.4.0
    17101710         *
    1711          * @returns {boolean}
     1711         * @return {boolean}
    17121712         */
    17131713        isContextuallyActive: function() {
     
    20622062        /**
    20632063         * @param {string} widgetId or an id_base for adding a previously non-existing widget.
    2064          * @returns {object|false} widget_form control instance, or false on error.
     2064         * @return {object|false} widget_form control instance, or false on error.
    20652065         */
    20662066        addWidget: function( widgetId ) {
     
    23312331    /**
    23322332     * @param {String} widgetId
    2333      * @returns {Object}
     2333     * @return {Object}
    23342334     */
    23352335    function parseWidgetId( widgetId ) {
     
    23532353    /**
    23542354     * @param {String} widgetId
    2355      * @returns {String} settingId
     2355     * @return {String} settingId
    23562356     */
    23572357    function widgetIdToSettingId( widgetId ) {
  • trunk/src/js/_enqueues/wp/dashboard.js

    r44896 r46800  
    2424     * @param {boolean} visible Should it be visible or not.
    2525     *
    26      * @returns {void}
     26     * @return {void}
    2727     */
    2828    updateWelcomePanel = function( visible ) {
     
    7373     * @param {string} el Optional. Widget to fetch or none to update all.
    7474     *
    75      * @returns {void}
     75     * @return {void}
    7676     */
    7777    window.ajaxPopulateWidgets = function(el) {
     
    8282         * @param {string} id ID of the element which is going to be checked for changes.
    8383         *
    84          * @returns {void}
     84         * @return {void}
    8585         */
    8686        function show(i, id) {
     
    128128     * @global
    129129     *
    130      * @returns {void}
     130     * @return {void}
    131131     */
    132132    window.quickPressLoad = function() {
     
    160160             * Highlights the latest post for one second.
    161161             *
    162              * @returns {void}
     162             * @return {void}
    163163             */
    164164            function highlightLatestPost () {
     
    190190     * @since 3.6.0
    191191     *
    192      * @returns {void}
     192     * @return {void}
    193193     */
    194194    function autoResizeTextarea() {
     
    286286         * @since 4.8.0
    287287         *
    288          * @returns {void}
     288         * @return {void}
    289289         */
    290290        init: function() {
     
    320320             * Filters events based on entered location.
    321321             *
    322              * @returns {void}
     322             * @return {void}
    323323             */
    324324            $container.on( 'submit', '.community-events-form', function( event ) {
     
    357357         *                              or an event object to flip between states.
    358358         *
    359          * @returns {void}
     359         * @return {void}
    360360         */
    361361        toggleLocationForm: function( action ) {
     
    402402         * @param {Object} requestParams REST API Request parameters object.
    403403         *
    404          * @returns {void}
     404         * @return {void}
    405405         */
    406406        getEvents: function( requestParams ) {
     
    456456         *                                'app' to indicate it was triggered automatically by the app itself.
    457457         *
    458          * @returns {void}
     458         * @return {void}
    459459         */
    460460        renderEventsTemplate: function( templateParams, initiatedBy ) {
  • trunk/src/js/_enqueues/wp/editor/base.js

    r46799 r46800  
    2727                 * @since 4.3.0
    2828                 *
    29                  * @returns {void}
     29                 * @return {void}
    3030                 */
    3131                $$( document ).on( 'click', function( event ) {
     
    4848         *
    4949         * @param {Object} editor The TinyMCE editor.
    50          * @returns {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,
    5151         * else return 30.
    5252         */
     
    7171         * @param {string} id The id of the editor you want to change the editor mode for. Default: `content`.
    7272         * @param {string} mode The mode you want to switch to. Default: `toggle`.
    73          * @returns {void}
     73         * @return {void}
    7474         */
    7575        function switchEditor( id, mode ) {
     
    203203         * @param {number} cursorPosition The cursor position inside the content.
    204204         *
    205          * @returns {(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.
    206206         */
    207207        function getContainingTagInfo( content, cursorPosition ) {
     
    660660         *
    661661         * @param {Object} editor The editor where we must find the selection.
    662          * @returns {(null|Object)} The selection range position in the editor.
     662         * @return {(null|Object)} The selection range position in the editor.
    663663         */
    664664        function findBookmarkedPosition( editor ) {
     
    10051005         *
    10061006         * @param {string} text The text input.
    1007          * @returns {string} The formatted text.
     1007         * @return {string} The formatted text.
    10081008         */
    10091009        function autop( text ) {
     
    11321132         *
    11331133         * @param {String} html The content from the visual editor.
    1134          * @returns {String} the filtered content.
     1134         * @return {String} the filtered content.
    11351135         */
    11361136        function pre_wpautop( html ) {
     
    11581158         *
    11591159         * @param {String} text The content from the text editor.
    1160          * @returns {String} filtered content.
     1160         * @return {String} filtered content.
    11611161         */
    11621162        function wpautop( text ) {
  • trunk/src/js/_enqueues/wp/editor/dfw.js

    r45172 r46800  
    1616     * @since 4.0.0
    1717     *
    18      * @returns {void}
     18     * @return {void}
    1919     */
    2020    $( function() {
     
    7171         * @since 4.6.1
    7272         *
    73          * @returns {void}
     73         * @return {void}
    7474         */
    7575        var shrinkTextarea = window._.throttle( function() {
     
    103103         * @since 4.6.1
    104104         *
    105          * @returns {void}
     105         * @return {void}
    106106         */
    107107        function textEditorResize() {
     
    136136         * @since 4.0.0
    137137         *
    138          * @returns {void}
     138         * @return {void}
    139139         */
    140140        function getHeights() {
     
    170170         * @param {object} editor The editor to bind the vents on.
    171171         *
    172          * @returns {void}
     172         * @return {void}
    173173         */
    174174        $document.on( 'tinymce-editor-init.editor-expand', function( event, editor ) {
     
    178178                 * Hides any float panel with a hover state. Additionally hides tooltips.
    179179                 *
    180                  * @returns {void}
     180                 * @return {void}
    181181                 */
    182182                hideFloatPanels = _.debounce( function() {
     
    205205             * Gets the offset of the editor.
    206206             *
    207              * @returns {Number|Boolean} Returns the offset of the editor
     207             * @return {Number|Boolean} Returns the offset of the editor
    208208             * or false if there is no offset height.
    209209             */
     
    242242             * @param {event} event The event to get the key code from.
    243243             *
    244              * @returns {void}
     244             * @return {void}
    245245             */
    246246            function mceKeyup( event ) {
     
    271271             * @param {string} key The key code of the pressed key.
    272272             *
    273              * @returns {void}
     273             * @return {void}
    274274             */
    275275            function mceScroll( key ) {
     
    332332             * @param {event} event The FullscreenStateChanged event.
    333333             *
    334              * @returns {void}
     334             * @return {void}
    335335             */
    336336            function mceFullscreenToggled( event ) {
     
    349349             * @since 4.0.0
    350350             *
    351              * @returns {void}
     351             * @return {void}
    352352             */
    353353            function mceShow() {
     
    368368             * @since 4.0.0
    369369             *
    370              * @returns {void}
     370             * @return {void}
    371371             */
    372372            function mceHide() {
     
    392392             * @since 4.1.0
    393393             *
    394              * @returns {void}
     394             * @return {void}
    395395             */
    396396            function toggleAdvanced() {
     
    403403             * @since 4.0.0
    404404             *
    405              * @returns {void}
     405             * @return {void}
    406406             */
    407407            mceBind = function() {
     
    428428             * @since 4.0.0
    429429             *
    430              * @returns {void}
     430             * @return {void}
    431431             */
    432432            mceUnbind = function() {
     
    461461         * @param {event} event The event that calls this function.
    462462         *
    463          * @returns {void}
     463         * @return {void}
    464464         */
    465465        function adjust( event ) {
     
    773773         * @since 4.0.0
    774774         *
    775          * @returns {void}
     775         * @return {void}
    776776         */
    777777        function fullscreenHide() {
     
    787787         * @param {function} callback The function to run in the timeout.
    788788         *
    789          * @returns {void}
     789         * @return {void}
    790790         */
    791791        function initialResize( callback ) {
     
    800800         * @since 4.0.0
    801801         *
    802          * @returns {void}
     802         * @return {void}
    803803         */
    804804        function afterScroll() {
     
    812812         * @since 4.0.0
    813813         *
    814          * @returns {void}
     814         * @return {void}
    815815         */
    816816        function on() {
     
    882882         * @since 4.0.0
    883883         *
    884          * @returns {void}
     884         * @return {void}
    885885         */
    886886        function off() {
     
    976976     * @since 4.1.0
    977977     *
    978      * @returns {void}
     978     * @return {void}
    979979     */
    980980    $( function() {
     
    10261026         * @since 4.1.0
    10271027         *
    1028          * @returns {void}
     1028         * @return {void}
    10291029         */
    10301030        function recalcEditorRect() {
     
    10391039         * @since 4.1.0
    10401040         *
    1041          * @returns {void}
     1041         * @return {void}
    10421042         */
    10431043        function activate() {
     
    10551055         * @since 4.1.0
    10561056         *
    1057          * @returns {void}
     1057         * @return {void}
    10581058         */
    10591059        function deactivate() {
     
    10731073         * @since 4.1.0
    10741074         *
    1075          * @returns {boolean} Returns true is _isActive is true.
     1075         * @return {boolean} Returns true is _isActive is true.
    10761076         */
    10771077        function isActive() {
     
    10841084         * @since 4.1.0
    10851085         *
    1086          * @returns {void}
     1086         * @return {void}
    10871087         */
    10881088        function on() {
     
    11071107         * @since 4.1.0
    11081108         *
    1109          * @returns {void}
     1109         * @return {void}
    11101110         */
    11111111        function off() {
     
    11301130         * @since 4.1.0
    11311131         *
    1132          * @returns {void}
     1132         * @return {void}
    11331133         */
    11341134        function toggle() {
     
    11451145         * @since 4.1.0
    11461146         *
    1147          * @returns {boolean} Returns true if _isOn is true.
     1147         * @return {boolean} Returns true if _isOn is true.
    11481148         */
    11491149        function isOn() {
     
    11621162         * @param event The event that triggers this function.
    11631163         *
    1164          * @returns {void}
     1164         * @return {void}
    11651165         */
    11661166        function fadeOut( event ) {
     
    13011301         * @param event The event that triggers this function.
    13021302         *
    1303          * @returns {void}
     1303         * @return {void}
    13041304         */
    13051305        function fadeIn( event ) {
     
    13471347         * @since 4.1.0
    13481348         *
    1349          * @returns {void}
     1349         * @return {void}
    13501350         */
    13511351        function maybeFadeIn() {
     
    13691369         * @since 4.1.0
    13701370         *
    1371          * @returns {void}
     1371         * @return {void}
    13721372         */
    13731373        function fadeOutAdminBar() {
     
    13901390         * @since 4.1.0
    13911391         *
    1392          * @returns {void}
     1392         * @return {void}
    13931393         */
    13941394        function fadeInAdminBar() {
     
    14051405         * @since 4.1.0
    14061406         *
    1407          * @returns {void}
     1407         * @return {void}
    14081408         */
    14091409        function fadeOutSlug() {
     
    14221422         * @since 4.1.0
    14231423         *
    1424          * @returns {void}
     1424         * @return {void}
    14251425         */
    14261426        function fadeInSlug() {
     
    14431443         * @param {event} event The event to trigger the toggle.
    14441444         *
    1445          * @returns {void}
     1445         * @return {void}
    14461446         */
    14471447        function toggleViaKeyboard( event ) {
     
    14631463         * @param {object} editor The editor to add the button to.
    14641464         *
    1465          * @returns {void}
     1465         * @return {void}
    14661466         */
    14671467        $document.on( 'tinymce-editor-setup.focus', function( event, editor ) {
     
    15121512         * @param {object} editor The editor to bind events on.
    15131513         *
    1514          * @returns {void}
     1514         * @return {void}
    15151515         */
    15161516        $document.on( 'tinymce-editor-init.focus', function( event, editor ) {
     
    15691569         * @param {object} editor The editor to bind events on.
    15701570         *
    1571          * @returns {void}
     1571         * @return {void}
    15721572         */
    15731573        $document.on( 'quicktags-init', function( event, editor ) {
  • trunk/src/js/_enqueues/wp/heartbeat.js

    r44275 r46800  
    3535     * @since 3.6.0
    3636     *
    37      * @returns {Object} An instance of the Heartbeat class.
     37     * @return {Object} An instance of the Heartbeat class.
    3838     * @constructor
    3939     */
     
    111111         * @since 3.8.0
    112112         *
    113          * @returns {void}
     113         * @return {void}
    114114         */
    115115        function initialize() {
     
    250250         * @since 3.6.0
    251251         *
    252          * @returns {number} Returns the current time.
     252         * @return {number} Returns the current time.
    253253         */
    254254        function time() {
     
    263263         * @since 3.6.0
    264264         *
    265          * @returns {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.
    266266         */
    267267        function isLocalFrame( frame ) {
     
    296296         * @since 4.1.0
    297297         *
    298          * @returns {void}
     298         * @return {void}
    299299         */
    300300        function checkFocus() {
     
    317317         *                        (200, 404, 500, etc.).
    318318         *
    319          * @returns {void}
     319         * @return {void}
    320320         */
    321321        function setErrorState( error, status ) {
     
    364364         * @since 3.8.0
    365365         *
    366          * @returns {void}
     366         * @return {void}
    367367         */
    368368        function clearErrorState() {
     
    385385         * @since 3.6.0
    386386         *
    387          * @returns {void}
     387         * @return {void}
    388388         */
    389389        function connect() {
     
    485485         * @since 3.8.0
    486486         *
    487          * @returns {void}
     487         * @return {void}
    488488         */
    489489        function scheduleNextTick() {
     
    531531         * @since 3.6.0
    532532         *
    533          * @returns {void}
     533         * @return {void}
    534534         */
    535535        function blurred() {
     
    544544         * @since 3.6.0
    545545         *
    546          * @returns {void}
     546         * @return {void}
    547547         */
    548548        function focused() {
     
    565565         * @since 3.6.0
    566566         *
    567          * @returns {void}
     567         * @return {void}
    568568         */
    569569        function userIsActive() {
     
    591591         * @since 3.8.0
    592592         *
    593          * @returns {void}
     593         * @return {void}
    594594         */
    595595        function checkUserActivity() {
     
    633633         * @memberOf wp.heartbeat.prototype
    634634         *
    635          * @returns {boolean} True if the window or the user is active.
     635         * @return {boolean} True if the window or the user is active.
    636636         */
    637637        function hasFocus() {
     
    646646         * @memberOf wp.heartbeat.prototype
    647647         *
    648          * @returns {boolean} True if a connection error was found.
     648         * @return {boolean} True if a connection error was found.
    649649         */
    650650        function hasConnectionError() {
     
    662662         * @memberOf wp.heartbeat.prototype
    663663         *
    664          * @returns {void}
     664         * @return {void}
    665665         */
    666666        function connectNow() {
     
    681681         * @memberOf wp.heartbeat.prototype
    682682         *
    683          * @returns {void}
     683         * @return {void}
    684684         */
    685685        function disableSuspend() {
     
    704704         *                              back. Used with speed = 'fast' or 5.
    705705         *
    706          * @returns {number} Current interval in seconds.
     706         * @return {number} Current interval in seconds.
    707707         */
    708708        function interval( speed, ticks ) {
     
    785785         * @param {boolean} noOverwrite Whether to overwrite existing data in the queue.
    786786         *
    787          * @returns {boolean} True if the data was queued.
     787         * @return {boolean} True if the data was queued.
    788788         */
    789789        function enqueue( handle, data, noOverwrite ) {
     
    806806         * @param {string} handle The handle for the data.
    807807         *
    808          * @returns {boolean} True if the data is queued with this handle.
     808         * @return {boolean} True if the data is queued with this handle.
    809809         */
    810810        function isQueued( handle ) {
     
    823823         * @param {string} handle The handle for the data.
    824824         *
    825          * @returns {void}
     825         * @return {void}
    826826         */
    827827        function dequeue( handle ) {
     
    840840         * @param {string} handle The handle for the data.
    841841         *
    842          * @returns {*} The data or undefined.
     842         * @return {*} The data or undefined.
    843843         */
    844844        function getQueuedItem( handle ) {
  • trunk/src/js/_enqueues/wp/media/audiovideo.js

    r43347 r46800  
    150150     *
    151151     * @param {string} data The text to apply the shortcode on.
    152      * @returns {wp.media} The media object.
     152     * @return {wp.media} The media object.
    153153     */
    154154    edit : function( data ) {
     
    170170     *
    171171     * @param {Array} model Array with attributes for the shortcode.
    172      * @returns {wp.shortcode} The audio shortcode object.
     172     * @return {wp.shortcode} The audio shortcode object.
    173173     */
    174174    shortcode : function( model ) {
     
    225225     *
    226226     * @param {string} data The text to apply the shortcode on.
    227      * @returns {wp.media} The media object.
     227     * @return {wp.media} The media object.
    228228     */
    229229    edit : function( data ) {
     
    250250     *
    251251     * @param {Array} model Array with attributes for the shortcode.
    252      * @returns {wp.shortcode} The video shortcode object.
     252     * @return {wp.shortcode} The video shortcode object.
    253253     */
    254254    shortcode : function( model ) {
  • trunk/src/js/_enqueues/wp/media/editor.js

    r46799 r46800  
    2222     * @param {object} attrs Map of props from a shortcode or settings.
    2323     * @param {string} key The key within the passed map to check for a value.
    24      * @returns {mixed|undefined} The original or coerced value of key within attrs.
     24     * @return {mixed|undefined} The original or coerced value of key within attrs.
    2525     */
    2626    wp.media.coerce = function ( attrs, key ) {
     
    4444         * @param {Object} [props={}] Attachment details (align, link, size, etc).
    4545         * @param {Object} attachment The attachment object, media version of Post.
    46          * @returns {Object} Joined props
     46         * @return {Object} Joined props
    4747         */
    4848        props: function( props, attachment ) {
     
    110110         * @param {Object} props Attachment details (align, link, size, etc).
    111111         * @param {Object} attachment The attachment object, media version of Post.
    112          * @returns {string} The link markup
     112         * @return {string} The link markup
    113113         */
    114114        link: function( props, attachment ) {
     
    136136         * @param {Object} props Attachment details (align, link, size, etc).
    137137         * @param {Object} attachment The attachment object, media version of Post.
    138          * @returns {string} The audio shortcode
     138         * @return {string} The audio shortcode
    139139         */
    140140        audio: function( props, attachment ) {
     
    146146         * @param {Object} props Attachment details (align, link, size, etc).
    147147         * @param {Object} attachment The attachment object, media version of Post.
    148          * @returns {string} The video shortcode
     148         * @return {string} The video shortcode
    149149         */
    150150        video: function( props, attachment ) {
     
    159159         * @param {Object} props Attachment details (align, link, size, etc).
    160160         * @param {Object} attachment The attachment object, media version of Post.
    161          * @returns {string} The media shortcode
     161         * @return {string} The media shortcode
    162162         */
    163163        _audioVideo: function( type, props, attachment ) {
     
    206206         * @param {Object} props Attachment details (align, link, size, etc).
    207207         * @param {Object} attachment The attachment object, media version of Post.
    208          * @returns {string}
     208         * @return {string}
    209209         */
    210210        image: function( props, attachment ) {
     
    346346             *
    347347             * @param {wp.shortcode} shortcode An instance of wp.shortcode().
    348              * @returns {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.
     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.
    352352             */
    353353            attachments: function( shortcode ) {
     
    415415             *      The query[ this.tag ] property is a Backbone.Model
    416416             *          containing the 'props' for the collection.
    417              * @returns {wp.shortcode}
     417             * @return {wp.shortcode}
    418418             */
    419419            shortcode: function( attachments ) {
     
    484484             * @this wp.media.{prop}
    485485             *
    486              * @returns {wp.media.view.MediaFrame.Select} A media workflow.
     486             * @return {wp.media.view.MediaFrame.Select} A media workflow.
    487487             */
    488488            edit: function( content ) {
     
    604604         * Get the featured image post ID
    605605         *
    606          * @returns {wp.media.view.settings.post.featuredImageId|number}
     606         * @return {wp.media.view.settings.post.featuredImageId|number}
    607607         */
    608608        get: function() {
     
    643643         * @this wp.media.featuredImage
    644644         *
    645          * @returns {wp.media.view.MediaFrame.Select} A media workflow.
     645         * @return {wp.media.view.MediaFrame.Select} A media workflow.
    646646         */
    647647        frame: function() {
     
    776776         * @this wp.media.editor
    777777         *
    778          * @returns {wp.media.view.MediaFrame.Select} A media workflow.
     778         * @return {wp.media.view.MediaFrame.Select} A media workflow.
    779779         */
    780780        add: function( id, options ) {
     
    880880         * @param {string} [id=''] A slug used to identify the workflow.
    881881         *
    882          * @returns {wpActiveEditor|string|tinymce.activeEditor.id}
     882         * @return {wpActiveEditor|string|tinymce.activeEditor.id}
    883883         */
    884884        id: function( id ) {
     
    906906         * @this wp.media.editor
    907907         *
    908          * @returns {wp.media.view.MediaFrame} A media workflow.
     908         * @return {wp.media.view.MediaFrame} A media workflow.
    909909         */
    910910        get: function( id ) {
     
    931931             * @param {Object} props Attachment details (align, link, size, etc).
    932932             * @param {Object} attachment The attachment object, media version of Post.
    933              * @returns {Promise}
     933             * @return {Promise}
    934934             */
    935935            attachment: function( props, attachment ) {
     
    985985             *
    986986             * @param {Object} embed
    987              * @returns {Promise}
     987             * @return {Promise}
    988988             */
    989989            link: function( embed ) {
     
    10051005         * @this wp.media.editor
    10061006         *
    1007          * @returns {wp.media.view.MediaFrame}
     1007         * @return {wp.media.view.MediaFrame}
    10081008         */
    10091009        open: function( id, options ) {
  • trunk/src/js/_enqueues/wp/media/models.js

    r43347 r46800  
    139139     *
    140140     * @param {Object} dimensions
    141      * @returns {Object}
     141     * @return {Object}
    142142     */
    143143    fit: function( dimensions ) {
     
    185185     * @param {Number} [length=30]
    186186     * @param {String} [replacement=&hellip;]
    187      * @returns {String} The string, unless length is greater than string.length.
     187     * @return {String} The string, unless length is greater than string.length.
    188188     */
    189189    truncate: function( string, length, replacement ) {
     
    209209 * @static
    210210 * @param {String} id A string used to identify a model.
    211  * @returns {wp.media.model.Attachment}
     211 * @return {wp.media.model.Attachment}
    212212 */
    213213media.attachment = function( id ) {
     
    229229 *
    230230 * @param {object} [props]
    231  * @returns {wp.media.model.Attachments}
     231 * @return {wp.media.model.Attachments}
    232232 */
    233233media.query = function( props ) {
  • trunk/src/js/_enqueues/wp/media/views.js

    r44969 r46800  
    5050 * @param {string} selector
    5151 * @param {Number} sensitivity
    52  * @returns {Promise}
     52 * @return {Promise}
    5353 */
    5454media.transition = function( selector, sensitivity ) {
  • trunk/src/js/_enqueues/wp/password-strength-meter.js

    r43577 r46800  
    2828         * @param {string} password2 The password confirmation.
    2929         *
    30          * @returns {number} The password strength score.
     30         * @return {number} The password strength score.
    3131         */
    3232        meter : function( password1, blacklist, password2 ) {
     
    5555         * @since 3.7.0
    5656         *
    57          * @returns {string[]} The array of words to be blacklisted.
     57         * @return {string[]} The array of words to be blacklisted.
    5858         */
    5959        userInputBlacklist : function() {
  • trunk/src/js/_enqueues/wp/theme-plugin-editor.js

    r46586 r46800  
    3737     * @param {object}         settings - Settings.
    3838     * @param {object|boolean} settings.codeEditor - Code editor settings (or `false` if syntax highlighting is disabled).
    39      * @returns {void}
     39     * @return {void}
    4040     */
    4141    component.init = function init( form, settings ) {
     
    9595     *
    9696     * @since 4.9.0
    97      * @returns {void}
     97     * @return {void}
    9898     */
    9999    component.showWarning = function() {
     
    126126     * @since 4.9.0
    127127     * @param {object} event jQuery event object.
    128      * @returns {void}
     128     * @return {void}
    129129     */
    130130    component.constrainTabbing = function( event ) {
     
    151151     *
    152152     * @since 4.9.0
    153      * @returns {void}
     153     * @return {void}
    154154     */
    155155    component.dismissWarning = function() {
     
    169169     *
    170170     * @since 4.9.0
    171      * @returns {void}
     171     * @return {void}
    172172     */
    173173    component.onChange = function() {
     
    181181     * @since 4.9.0
    182182     * @param {jQuery.Event} event - Event.
    183      * @returns {void}
     183     * @return {void}
    184184     */
    185185    component.submit = function( event ) {
     
    268268     * @param {boolean}  [notice.dismissible=false] - Dismissible.
    269269     * @param {Function} [notice.onDismiss] - Callback for when a user dismisses the notice.
    270      * @returns {jQuery} Notice element.
     270     * @return {jQuery} Notice element.
    271271     */
    272272    component.addNotice = function( notice ) {
     
    304304     *
    305305     * @param {string} code - Notice code.
    306      * @returns {boolean} Whether a notice was removed.
     306     * @return {boolean} Whether a notice was removed.
    307307     */
    308308    component.removeNotice = function( code ) {
     
    321321     *
    322322     * @since 4.9.0
    323      * @returns {void}
     323     * @return {void}
    324324     */
    325325    component.initCodeEditor = function initCodeEditor() {
     
    333333         * @since 4.9.0
    334334         *
    335          * @returns {void}
     335         * @return {void}
    336336         */
    337337        codeEditorSettings.onTabPrevious = function() {
     
    344344         * @since 4.9.0
    345345         *
    346          * @returns {void}
     346         * @return {void}
    347347         */
    348348        codeEditorSettings.onTabNext = function() {
     
    356356         *
    357357         * @param {Array} errors - List of linting errors.
    358          * @returns {void}
     358         * @return {void}
    359359         */
    360360        codeEditorSettings.onChangeLintingErrors = function( errors ) {
     
    373373         *
    374374         * @param {Array} errorAnnotations - Error annotations.
    375          * @returns {void}
     375         * @return {void}
    376376         */
    377377        codeEditorSettings.onUpdateErrorNotice = function onUpdateErrorNotice( errorAnnotations ) {
     
    425425     *
    426426     * @since 4.9.0
    427      * @returns {void}
     427     * @return {void}
    428428     */
    429429    component.initFileBrowser = function initFileBrowser() {
  • trunk/src/js/_enqueues/wp/theme.js

    r45557 r46800  
    14001400 * @param {string} url - URL to navigate to.
    14011401 * @param {object} state - State.
    1402  * @returns {void}
     1402 * @return {void}
    14031403 */
    14041404function navigateRouter( url, state ) {
  • trunk/src/js/_enqueues/wp/updates.js

    r46348 r46800  
    15991599     * @param {string} response.errorMessage The error that occurred.
    16001600     * @param {string} action                The type of request to perform.
    1601      * @returns {boolean} Whether there is an error that needs to be handled or not.
     1601     * @return {boolean} Whether there is an error that needs to be handled or not.
    16021602     */
    16031603    wp.updates.maybeHandleCredentialError = function( response, action ) {
  • trunk/src/js/_enqueues/wp/utils/word-count.js

    r43347 r46800  
    4242     *                                                            from the text.
    4343     *
    44      * @return void
     44     * @return {void}
    4545     */
    4646    function WordCounter( settings ) {
  • trunk/src/js/_enqueues/wp/widgets/custom-html.js

    r46586 r46800  
    4545         * @param {jQuery} options.syncContainer - Container element where fields are synced for the server.
    4646         *
    47          * @returns {void}
     47         * @return {void}
    4848         */
    4949        initialize: function initialize( options ) {
     
    9898         * overwriting content that the user is entering.
    9999         *
    100          * @returns {void}
     100         * @return {void}
    101101         */
    102102        updateFields: function updateFields() {
     
    124124         *
    125125         * @param {Array} errorAnnotations - Error annotations.
    126          * @returns {void}
     126         * @return {void}
    127127         */
    128128        updateErrorNotice: function( errorAnnotations ) {
     
    165165         * Initialize editor.
    166166         *
    167          * @returns {void}
     167         * @return {void}
    168168         */
    169169        initializeEditor: function initializeEditor() {
     
    181181                 * @ignore
    182182                 *
    183                  * @returns {void}
     183                 * @return {void}
    184184                 */
    185185                onTabPrevious: function onTabPrevious() {
     
    192192                 * @ignore
    193193                 *
    194                  * @returns {void}
     194                 * @return {void}
    195195                 */
    196196                onTabNext: function onTabNext() {
     
    205205                 *
    206206                 * @param {Array} errorAnnotations - Error notifications.
    207                  * @returns {void}
     207                 * @return {void}
    208208                 */
    209209                onChangeLintingErrors: function onChangeLintingErrors( errorAnnotations ) {
     
    217217                 *
    218218                 * @param {Array} errorAnnotations - Error annotations.
    219                  * @returns {void}
     219                 * @return {void}
    220220                 */
    221221                onUpdateErrorNotice: function onUpdateErrorNotice( errorAnnotations ) {
     
    289289     * @param {jQuery}       widgetContainer - Widget container element.
    290290     *
    291      * @returns {void}
     291     * @return {void}
    292292     */
    293293    component.handleWidgetAdded = function handleWidgetAdded( event, widgetContainer ) {
     
    348348     * @alias wp.customHtmlWidgets.setupAccessibleMode
    349349     *
    350      * @returns {void}
     350     * @return {void}
    351351     */
    352352    component.setupAccessibleMode = function setupAccessibleMode() {
     
    385385     * @param {jQuery.Event} event - Event.
    386386     * @param {jQuery}       widgetContainer - Widget container element.
    387      * @returns {void}
     387     * @return {void}
    388388     */
    389389    component.handleWidgetUpdated = function handleWidgetUpdated( event, widgetContainer ) {
     
    416416     * @param {object} settings - Options for code editor, exported from PHP.
    417417     *
    418      * @returns {void}
     418     * @return {void}
    419419     */
    420420    component.init = function init( settings ) {
  • trunk/src/js/_enqueues/wp/widgets/media-audio.js

    r46586 r46800  
    2020         * Create the default states.
    2121         *
    22          * @returns {void}
     22         * @return {void}
    2323         */
    2424        createStates: function createStates() {
     
    7171         *
    7272         * @param {Object} modelProps - Model props.
    73          * @returns {Object} Media frame props.
     73         * @return {Object} Media frame props.
    7474         */
    7575        mapModelToMediaFrameProps: function mapModelToMediaFrameProps( modelProps ) {
     
    8383         * Render preview.
    8484         *
    85          * @returns {void}
     85         * @return {void}
    8686         */
    8787        renderPreview: function renderPreview() {
     
    110110         * Open the media audio-edit frame to modify the selected item.
    111111         *
    112          * @returns {void}
     112         * @return {void}
    113113         */
    114114        editMedia: function editMedia() {
  • trunk/src/js/_enqueues/wp/widgets/media-gallery.js

    r46586 r46800  
    2222         *
    2323         * @since 4.9.0
    24          * @returns {void}
     24         * @return {void}
    2525         */
    2626        createStates: function createStates() {
     
    8989         * @param {jQuery}         options.el - Control field container element.
    9090         * @param {jQuery}         options.syncContainer - Container element where fields are synced for the server.
    91          * @returns {void}
     91         * @return {void}
    9292         */
    9393        initialize: function initialize( options ) {
     
    123123         *
    124124         * @since 4.9.0
    125          * @returns {void}
     125         * @return {void}
    126126         */
    127127        updateSelectedAttachments: function updateSelectedAttachments() {
     
    156156         *
    157157         * @since 4.9.0
    158          * @returns {void}
     158         * @return {void}
    159159         */
    160160        renderPreview: function renderPreview() {
     
    177177         *
    178178         * @since 4.9.0
    179          * @returns {boolean} Selected.
     179         * @return {boolean} Selected.
    180180         */
    181181        isSelected: function isSelected() {
     
    193193         *
    194194         * @since 4.9.0
    195          * @returns {void}
     195         * @return {void}
    196196         */
    197197        editMedia: function editMedia() {
     
    256256         *
    257257         * @since 4.9.0
    258          * @returns {void}
     258         * @return {void}
    259259         */
    260260        selectMedia: function selectMedia() {
     
    322322         * @since 4.9.0
    323323         * @param {wp.media.models.Attachment} attachment - Attachment.
    324          * @returns {void}
     324         * @return {void}
    325325         */
    326326        handleAttachmentDestroy: function handleAttachmentDestroy( attachment ) {
  • trunk/src/js/_enqueues/wp/widgets/media-image.js

    r46586 r46800  
    4141         * Render preview.
    4242         *
    43          * @returns {void}
     43         * @return {void}
    4444         */
    4545        renderPreview: function renderPreview() {
     
    6565         * Open the media image-edit frame to modify the selected item.
    6666         *
    67          * @returns {void}
     67         * @return {void}
    6868         */
    6969        editMedia: function editMedia() {
     
    120120         * Get props which are merged on top of the model when an embed is chosen (as opposed to an attachment).
    121121         *
    122          * @returns {Object} Reset/override props.
     122         * @return {Object} Reset/override props.
    123123         */
    124124        getEmbedResetProps: function getEmbedResetProps() {
     
    139139         *
    140140         * @param {wp.media.view.MediaFrame.Select} mediaFrame - Select frame.
    141          * @returns {Object} Props.
     141         * @return {Object} Props.
    142142         */
    143143        getModelPropsFromMediaFrame: function getModelPropsFromMediaFrame( mediaFrame ) {
     
    152152         * Map model props to preview template props.
    153153         *
    154          * @returns {Object} Preview template props.
     154         * @return {Object} Preview template props.
    155155         */
    156156        mapModelToPreviewTemplateProps: function mapModelToPreviewTemplateProps() {
  • trunk/src/js/_enqueues/wp/widgets/media-video.js

    r46586 r46800  
    2222         * Create the default states.
    2323         *
    24          * @returns {void}
     24         * @return {void}
    2525         */
    2626        createStates: function createStates() {
     
    8989         *
    9090         * @param {Object} modelProps - Model props.
    91          * @returns {Object} Media frame props.
     91         * @return {Object} Media frame props.
    9292         */
    9393        mapModelToMediaFrameProps: function mapModelToMediaFrameProps( modelProps ) {
     
    101101         * Fetches embed data for external videos.
    102102         *
    103          * @returns {void}
     103         * @return {void}
    104104         */
    105105        fetchEmbed: function fetchEmbed() {
     
    145145         * @deprecated since 4.9.
    146146         *
    147          * @returns {boolean} Whether url is a supported video host.
     147         * @return {boolean} Whether url is a supported video host.
    148148         */
    149149        isHostedVideo: function isHostedVideo() {
     
    154154         * Render preview.
    155155         *
    156          * @returns {void}
     156         * @return {void}
    157157         */
    158158        renderPreview: function renderPreview() {
     
    212212         * Open the media image-edit frame to modify the selected item.
    213213         *
    214          * @returns {void}
     214         * @return {void}
    215215         */
    216216        editMedia: function editMedia() {
  • trunk/src/js/_enqueues/wp/widgets/media.js

    r46745 r46800  
    4646         * @param {Object} options - Options.
    4747         *
    48          * @returns {void}
     48         * @return {void}
    4949         */
    5050        initialize: function initialize( options ) {
     
    5757         *
    5858         * @param {Backbone.Model} displaySettings - Modified display settings.
    59          * @returns {void}
     59         * @return {void}
    6060         */
    6161        handleDisplaySettingChange: function handleDisplaySettingChange( displaySettings ) {
     
    7272         *
    7373         * @param {Backbone.Model} model - Display settings model.
    74          * @returns {Backbone.Model} Display settings model.
     74         * @return {Backbone.Model} Display settings model.
    7575         */
    7676        display: function getDisplaySettingsModel( model ) {
     
    102102         *
    103103         * @param {object} options - Options.
    104          * @returns {void}
     104         * @return {void}
    105105         */
    106106        initialize: function( options ) {
     
    118118         * Forked override of {wp.media.view.Embed#refresh()} to suppress irrelevant "link text" field.
    119119         *
    120          * @returns {void}
     120         * @return {void}
    121121         */