Make WordPress Core

Ticket #42901: jsdoc-no-summaries.patch

File jsdoc-no-summaries.patch, 82.1 KB (added by herregroen, 7 years ago)
  • src/wp-admin/js/color-picker.js

    diff --git src/wp-admin/js/color-picker.js src/wp-admin/js/color-picker.js
    index 7574820c6..506f96a31 100644
     
    1010                _wrappingLabelText = '<span class="screen-reader-text"></span>';
    1111
    1212        /**
    13          * @summary Creates a jQuery UI color picker.
    14          *
    1513         * Creates a jQuery UI color picker that is used in the theme customizer.
    1614         *
    1715         * @since 3.5.0
     
    2927                        slider: 'horizontal'
    3028                },
    3129                /**
    32                  * @summary Creates a color picker that only allows you to adjust the hue.
     30                 * Creates a color picker that only allows you to adjust the hue.
    3331                 *
    3432                 * @since 3.5.0
    3533                 *
     
    5452                                hide: false,
    5553                                color: color,
    5654                                /**
    57                                  * @summary Handles the onChange event if one has been defined in the options.
     55                                 * Handles the onChange event if one has been defined in the options.
    5856                                 *
    5957                                 * @param {Event} event    The event that's being called.
    6058                                 * @param {HTMLElement} ui The HTMLElement containing the color picker.
     
    7169                        } );
    7270                },
    7371                /**
    74                  * @summary Creates the color picker.
    75                  *
    7672                 * Creates the color picker, sets default values, css classes and wraps it all in HTML.
    7773                 *
    7874                 * @since 3.5.0
     
    172168                                mode: self.options.mode,
    173169                                palettes: self.options.palettes,
    174170                                /**
    175                                  * @summary Handles the onChange event if one has been defined in the options.
    176                                  *
    177171                                 * Handles the onChange event if one has been defined in the options and additionally
    178172                                 * sets the background color for the toggler element.
    179173                                 *
     
    202196                        }
    203197                },
    204198                /**
    205                  * @summary Binds event listeners to the color picker.
     199                 * Binds event listeners to the color picker.
    206200                 *
    207201                 * @since 3.5.0
    208202                 *
     
    214208                        var self = this;
    215209
    216210                        /**
    217                          * @summary Prevent any clicks inside this widget from leaking to the top and closing it.
     211                         * Prevent any clicks inside this widget from leaking to the top and closing it.
    218212                         *
    219213                         * @since 3.5.0
    220214                         *
     
    227221                        });
    228222
    229223                        /**
    230                          * @summary Open or close the color picker depending on the class.
     224                         * Open or close the color picker depending on the class.
    231225                         *
    232226                         * @since 3.5
    233227                         */
     
    240234                        });
    241235
    242236                        /**
    243                          * @summary Checks if value is empty when changing the color in the color picker.
    244                          *
    245237                         * Checks if value is empty when changing the color in the color picker.
    246238                         * If so, the background color is cleared.
    247239                         *
     
    265257                        });
    266258
    267259                        /**
    268                          * @summary Enables the user to clear or revert the color in the color picker.
    269                          *
    270260                         * Enables the user to either clear the color in the color picker or revert back to the default color.
    271261                         *
    272262                         * @since 3.5.0
     
    289279                        });
    290280                },
    291281                /**
    292                  * @summary Opens the color picker dialog.
     282                 * Opens the color picker dialog.
    293283                 *
    294284                 * @since 3.5.0
    295285                 *
     
    305295                        $( 'body' ).trigger( 'click.wpcolorpicker' ).on( 'click.wpcolorpicker', this.close );
    306296                },
    307297                /**
    308                  * @summary Closes the color picker dialog.
     298                 * Closes the color picker dialog.
    309299                 *
    310300                 * @since 3.5.0
    311301                 *
     
    321311                        $( 'body' ).off( 'click.wpcolorpicker', this.close );
    322312                },
    323313                /**
    324                  * @summary Returns iris object or sets new color.
    325                  *
    326314                 * Returns the iris object if no new color is provided. If a new color is provided, it sets the new color.
    327315                 *
    328316                 * @param newColor {string|*} The new color to use. Can be undefined.
     
    338326                        this.element.iris( 'option', 'color', newColor );
    339327                },
    340328                /**
    341                  * @summary Returns iris object or sets new default color.
    342                  *
    343329                 * Returns the iris object if no new default color is provided.
    344330                 * If a new default color is provided, it sets the new default color.
    345331                 *
  • src/wp-admin/js/comment.js

    diff --git src/wp-admin/js/comment.js src/wp-admin/js/comment.js
    index 3541a2f68..6308d8e83 100644
     
    11/* global postboxes, commentL10n */
    22
    33/**
    4  * @summary Binds to the document ready event.
     4 * Binds to the document ready event.
    55 *
    66 * @since 2.5.0
    77 *
    jQuery(document).ready( function($) { 
    1818                $edittimestamp = $timestampdiv.siblings( 'a.edit-timestamp' );
    1919
    2020        /**
    21          * @summary Adds event that opens the time stamp form if the form is hidden.
     21         * Adds event that opens the time stamp form if the form is hidden.
    2222         *
    2323         * @listens $edittimestamp:click
    2424         *
    jQuery(document).ready( function($) { 
    3737        });
    3838
    3939        /**
    40          * @summary Resets the time stamp values when the cancel button is clicked.
     40         * Resets the time stamp values when the cancel button is clicked.
    4141         *
    4242         * @listens .cancel-timestamp:click
    4343         *
    jQuery(document).ready( function($) { 
    5959        });
    6060
    6161        /**
    62          * @summary Sets the time stamp values when the ok button is clicked.
     62         * Sets the time stamp values when the ok button is clicked.
    6363         *
    6464         * @listens .save-timestamp:click
    6565         *
  • src/wp-admin/js/common.js

    diff --git src/wp-admin/js/common.js src/wp-admin/js/common.js
    index c9e50d706..394648bef 100644
     
    22var showNotice, adminMenu, columns, validateForm, screenMeta;
    33
    44/**
    5  *  @summary Adds common WordPress functionality to the window.
     5 *  Adds common WordPress functionality to the window.
    66 *
    77 *  @param {jQuery} $        jQuery object.
    88 *  @param {Object} window   The window object.
    var showNotice, adminMenu, columns, validateForm, screenMeta; 
    1414                $body = $( document.body );
    1515
    1616/**
    17  * @summary Removed in 3.3.0, needed for back-compatibility.
     17 * Removed in 3.3.0, needed for back-compatibility.
    1818 *
    1919 * @since 2.7.0
    2020 * @deprecated 3.3.0
    adminMenu = { 
    3131columns = {
    3232
    3333        /**
    34          * @summary Initializes the column toggles in the screen options.
     34         * Initializes the column toggles in the screen options.
    3535         *
    3636         * Binds an onClick event to the checkboxes to show or hide the table columns
    3737         * based on their toggled state. And persists the toggled state.
    columns = { 
    5454        },
    5555
    5656        /**
    57          * @summary Saves the toggled state for the columns.
     57         * Saves the toggled state for the columns.
    5858         *
    5959         * Saves whether the columns should be shown or hidden on a page.
    6060         *
    columns = { 
    7373        },
    7474
    7575        /**
    76          * @summary Makes a column visible and adjusts the column span for the table.
     76         * Makes a column visible and adjusts the column span for the table.
    7777         *
    7878         * @since 3.0.0
    7979         * @param {string} column The column name.
    columns = { 
    8686        },
    8787
    8888        /**
    89          * @summary Hides a column and adjusts the column span for the table.
     89         * Hides a column and adjusts the column span for the table.
    9090         *
    9191         * @since 3.0.0
    9292         * @param {string} column The column name.
    columns = { 
    9999        },
    100100
    101101        /**
    102          * @summary Get all hidden columns.
     102         * Gets all hidden columns.
    103103         *
    104104         * @since 3.0.0
    105105         *
    columns = { 
    112112        },
    113113
    114114        /**
    115          * @summary Gets the checked column toggles from the screen options.
     115         * Gets the checked column toggles from the screen options.
    116116         *
    117117         * @since 3.0.0
    118118         *
    columns = { 
    128128        },
    129129
    130130        /**
    131          * @summary Adjusts the column span for the table.
     131         * Adjusts the column span for the table.
    132132         *
    133133         * @since 3.1.0
    134134         *
    columns = { 
    146146$document.ready(function(){columns.init();});
    147147
    148148/**
    149  * @summary Validates that the required form fields are not empty.
     149 * Validates that the required form fields are not empty.
    150150 *
    151151 * @since 2.9.0
    152152 *
    validateForm = function( form ) { 
    166166
    167167// stub for doing better warnings
    168168/**
    169  * @summary Shows message pop-up notice or confirmation message.
     169 * Shows message pop-up notice or confirmation message.
    170170 *
    171171 * @since 2.7.0
    172172 *
    validateForm = function( form ) { 
    177177showNotice = {
    178178
    179179        /**
    180          * @summary Shows a delete confirmation pop-up message.
     180         * Shows a delete confirmation pop-up message.
    181181         *
    182182         * @since 2.7.0
    183183         *
    showNotice = { 
    193193        },
    194194
    195195        /**
    196          * @summary Shows an alert message.
     196         * Shows an alert message.
    197197         *
    198198         * @since 2.7.0
    199199         *
    showNotice = { 
    205205};
    206206
    207207/**
    208  * @summary Represents the functions for the meta screen options panel.
     208 * Represents the functions for the meta screen options panel.
    209209 *
    210210 * @since 3.2.0
    211211 *
    screenMeta = { 
    221221        page:    null, // #wpcontent
    222222
    223223        /**
    224          * @summary Initializes the screen meta options panel.
     224         * Initializes the screen meta options panel.
    225225         *
    226226         * @since 3.2.0
    227227         *
    screenMeta = { 
    236236        },
    237237
    238238        /**
    239          * @summary Toggles the screen meta options panel.
     239         * Toggles the screen meta options panel.
    240240         *
    241241         * @since 3.2.0
    242242         *
    screenMeta = { 
    255255        },
    256256
    257257        /**
    258          * @summary Opens the screen meta options panel.
     258         * Opens the screen meta options panel.
    259259         *
    260260         * @since 3.2.0
    261261         *
    screenMeta = { 
    271271                panel.parent().show();
    272272
    273273                /**
    274                  * @summary Sets the focus to the meta options panel and adds the necessary CSS classes.
     274                 * Sets the focus to the meta options panel and adds the necessary CSS classes.
    275275                 *
    276276                 * @since 3.2.0
    277277                 *
    screenMeta = { 
    286286        },
    287287
    288288        /**
    289          * @summary Closes the screen meta options panel.
     289         * Closes the screen meta options panel.
    290290         *
    291291         * @since 3.2.0
    292292         *
    screenMeta = { 
    297297         */
    298298        close: function( panel, button ) {
    299299                /**
    300                  * @summary Hides the screen meta options panel.
     300                 * Hides the screen meta options panel.
    301301                 *
    302302                 * @since 3.2.0
    303303                 *
    screenMeta = { 
    314314};
    315315
    316316/**
    317  * @summary Initializes the help tabs in the help panel.
     317 * Initializes the help tabs in the help panel.
    318318 *
    319319 * @param {Event} e The event object.
    320320 *
    $document.ready( function() { 
    495495                $headerEnd = $( '.wp-header-end' );
    496496
    497497        /**
    498          * @summary Makes the fly-out submenu header clickable, when the menu is folded.
     498         * Makes the fly-out submenu header clickable, when the menu is folded.
    499499         *
    500500         * @param {Event} e The event object.
    501501         *
    $document.ready( function() { 
    506506        });
    507507
    508508        /**
    509          * @summary Collapses the admin menu.
     509         * Collapses the admin menu.
    510510         *
    511511         * @returns {void}
    512512         */
    $document.ready( function() { 
    543543        });
    544544
    545545        /**
    546          * @summary Handles the `aria-haspopup` attribute on the current menu item when it has a submenu.
     546         * Handles the `aria-haspopup` attribute on the current menu item when it has a submenu.
    547547         *
    548548         * @since 4.4.0
    549549         *
    $document.ready( function() { 
    564564        $document.on( 'wp-menu-state-set wp-collapse-menu wp-responsive-activate wp-responsive-deactivate', currentMenuItemHasPopup );
    565565
    566566        /**
    567          * @summary Ensures an admin submenu is within the visual viewport.
     567         * Ensures an admin submenu is within the visual viewport.
    568568         *
    569569         * @since 4.1.0
    570570         *
    $document.ready( function() { 
    605605                mobileEvent = isIOS ? 'touchstart' : 'click';
    606606
    607607                /**
    608                  * @summary Closes any open submenus when touch/click is not on the menu.
     608                 * Closes any open submenus when touch/click is not on the menu.
    609609                 *
    610610                 * @param {Event} e The event object.
    611611                 *
    $document.ready( function() { 
    622622                });
    623623
    624624                /**
    625                  * @summary Handles the opening or closing the submenu based on the mobile click|touch event.
     625                 * Handles the opening or closing the submenu based on the mobile click|touch event.
    626626                 *
    627627                 * @param {Event} event The event object.
    628628                 *
    $document.ready( function() { 
    651651                $adminmenu.find( 'li.wp-has-submenu' ).hoverIntent({
    652652
    653653                        /**
    654                          * @summary Opens the submenu when hovered over the menu item for desktops.
     654                         * Opens the submenu when hovered over the menu item for desktops.
    655655                         *
    656656                         * @returns {void}
    657657                         */
    $document.ready( function() { 
    675675                        },
    676676
    677677                        /**
    678                          * @summary Closes the submenu when no longer hovering the menu item.
     678                         * Closes the submenu when no longer hovering the menu item.
    679679                         *
    680680                         * @returns {void}
    681681                         */
    $document.ready( function() { 
    693693                });
    694694
    695695                /**
    696                  * @summary Opens the submenu on when focused on the menu item.
     696                 * Opens the submenu on when focused on the menu item.
    697697                 *
    698698                 * @param {Event} event The event object.
    699699                 *
    $document.ready( function() { 
    708708                        $( event.target ).closest( 'li.menu-top' ).addClass( 'opensub' );
    709709
    710710                        /**
    711                          * @summary Closes the submenu on blur from the menu item.
     711                         * Closes the submenu on blur from the menu item.
    712712                         *
    713713                         * @param {Event} event The event object.
    714714                         *
    $document.ready( function() { 
    722722                        $( event.target ).closest( 'li.menu-top' ).removeClass( 'opensub' );
    723723
    724724                        /**
    725                          * @summary Adjusts the size for the submenu.
     725                         * Adjusts the size for the submenu.
    726726                         *
    727727                         * @returns {void}
    728728                         */
    $document.ready( function() { 
    743743        $( 'div.updated, div.error, div.notice' ).not( '.inline, .below-h2' ).insertAfter( $headerEnd );
    744744
    745745        /**
    746          * @summary Make notices dismissible.
     746         * Makes notices dismissible.
    747747         *
    748748         * @since 4.4.0
    749749         *
    $document.ready( function() { 
    776776        screenMeta.init();
    777777
    778778        /**
    779          * @summary Checks a checkbox.
     779         * Checks a checkbox.
    780780         *
    781781         * This event needs to be delegated. Ticket #37973.
    782782         *
    $document.ready( function() { 
    807807                var unchecked = $(this).closest('tbody').find(':checkbox').filter(':visible:enabled').not(':checked');
    808808
    809809                /**
    810                  * @summary Determines if all checkboxes are checked.
     810                 * Determines if all checkboxes are checked.
    811811                 *
    812812                 * @returns {boolean} Returns true if there are no unchecked checkboxes.
    813813                 */
    $document.ready( function() { 
    819819        });
    820820
    821821        /**
    822          * @summary Controls all the toggles on bulk toggle change.
     822         * Controls all the toggles on bulk toggle change.
    823823         *
    824824         * When the bulk checkbox is changed, all the checkboxes in the tables are changed accordingly.
    825825         * When the shift-button is pressed while changing the bulk checkbox the checkboxes in the table are inverted.
    $document.ready( function() { 
    839839                $table.children( 'tbody' ).filter(':visible')
    840840                        .children().children('.check-column').find(':checkbox')
    841841                        /**
    842                          * @summary Updates the checked state on the checkbox in the table.
     842                         * Updates the checked state on the checkbox in the table.
    843843                         *
    844844                         * @returns {boolean} True checks the checkbox, False unchecks the checkbox.
    845845                         */
    $document.ready( function() { 
    861861                        .children().children('.check-column').find(':checkbox')
    862862
    863863                        /**
    864                          * @summary Syncs the bulk checkboxes on the top and bottom of the table.
     864                         * Syncs the bulk checkboxes on the top and bottom of the table.
    865865                         *
    866866                         * @returns {boolean} True checks the checkbox, False unchecks the checkbox.
    867867                         */
    $document.ready( function() { 
    877877        });
    878878
    879879        /**
    880          * @summary Shows row actions on focus of its parent container element or any other elements contained within.
     880         * Shows row actions on focus of its parent container element or any other elements contained within.
    881881         *
    882882         * @returns {void}
    883883         */
    $document.ready( function() { 
    910910        });
    911911
    912912        /**
    913          * @summary Handles tab keypresses in theme and plugin editor textareas.
     913         * Handles tab keypresses in theme and plugin editor textareas.
    914914         *
    915915         * @param {Event} e The event object.
    916916         *
    $document.ready( function() { 
    964964        if ( pageInput.length ) {
    965965
    966966                /**
    967                  * @summary Handles pagination variable when filtering the list table.
     967                 * Handles pagination variable when filtering the list table.
    968968                 *
    969969                 * Set the pagination argument to the first page when the post-filter form is submitted.
    970970                 * This happens when pressing the 'filter' button on the list table page.
    $document.ready( function() { 
    986986        }
    987987
    988988        /**
    989          * @summary Resets the bulk actions when the search button is clicked.
     989         * Resets the bulk actions when the search button is clicked.
    990990         *
    991991         * @returns {void}
    992992         */
    $document.ready( function() { 
    995995        });
    996996
    997997        /**
    998          * @summary Scrolls into view when focus.scroll-into-view is triggered.
     998         * Scrolls into view when focus.scroll-into-view is triggered.
    999999         *
    10001000         * @param {Event} e The event object.
    10011001         *
    $document.ready( function() { 
    10071007        });
    10081008
    10091009        /**
    1010          * @summary Disables the submit upload buttons when no data is entered.
     1010         * Disables the submit upload buttons when no data is entered.
    10111011         *
    10121012         * @returns {void}
    10131013         */
    $document.ready( function() { 
    10221022                input = form.find('input[type="file"]');
    10231023
    10241024                /**
    1025                  * @summary Determines if any data is entered in any file upload input.
     1025                 * Determines if any data is entered in any file upload input.
    10261026                 *
    10271027                 * @since 3.5.0
    10281028                 *
    $document.ready( function() { 
    10421042        })();
    10431043
    10441044        /**
    1045          * @summary Pins the menu while distraction-free writing is enabled.
     1045         * Pins the menu while distraction-free writing is enabled.
    10461046         *
    10471047         * @param {Event} event Event data.
    10481048         *
    $document.ready( function() { 
    11871187        }
    11881188
    11891189        /**
    1190          * @summary Determines the height of certain elements.
     1190         * Determines the height of certain elements.
    11911191         *
    11921192         * @since 4.1.0
    11931193         *
    $document.ready( function() { 
    12031203        }
    12041204
    12051205        /**
    1206          * @summary Unpins the menu.
     1206         * Unpins the menu.
    12071207         *
    12081208         * @since 4.1.0
    12091209         *
    $document.ready( function() { 
    12231223        }
    12241224
    12251225        /**
    1226          * @summary Pins and unpins the menu when applicable.
     1226         * Pins and unpins the menu when applicable.
    12271227         *
    12281228         * @since 4.1.0
    12291229         *
    $document.ready( function() { 
    12521252        }
    12531253
    12541254        /**
    1255          * @summary Changes properties of metaboxes and body.
    1256          *
    12571255         * Changes the sortables and responsiveness of metaboxes.
    12581256         *
    12591257         * @since 3.8.0
    $document.ready( function() { 
    12631261        window.wpResponsive = {
    12641262
    12651263                /**
    1266                  * @summary Initializes the wpResponsive object.
     1264                 * Initializes the wpResponsive object.
    12671265                 *
    12681266                 * @since 3.8.0
    12691267                 *
    $document.ready( function() { 
    13211319                },
    13221320
    13231321                /**
    1324                  * @summary Changes properties of body and admin menu.
     1322                 * Changes properties of body and admin menu.
    13251323                 *
    13261324                 * Pins and unpins the menu and adds the auto-fold class to the body.
    13271325                 * Makes the admin menu responsive and disables the metabox sortables.
    $document.ready( function() { 
    13421340                },
    13431341
    13441342                /**
    1345                  * @summary Changes properties of admin menu and enables metabox sortables.
     1343                 * Changes properties of admin menu and enables metabox sortables.
    13461344                 *
    13471345                 * Pin and unpin the menu.
    13481346                 * Removes the responsiveness of the admin menu and enables the metabox sortables.
    $document.ready( function() { 
    13581356                },
    13591357
    13601358                /**
    1361                  * @summary Sets the responsiveness and enables the overlay based on the viewport width.
     1359                 * Sets the responsiveness and enables the overlay based on the viewport width.
    13621360                 *
    13631361                 * @since 3.8.0
    13641362                 *
    $document.ready( function() { 
    13921390                },
    13931391
    13941392                /**
    1395                  * @summary Inserts a responsive overlay and toggles the window.
     1393                 * Inserts a responsive overlay and toggles the window.
    13961394                 *
    13971395                 * @since 3.8.0
    13981396                 *
    $document.ready( function() { 
    14151413                },
    14161414
    14171415                /**
    1418                  * @summary Disables the responsive overlay and removes the overlay.
     1416                 * Disables the responsive overlay and removes the overlay.
    14191417                 *
    14201418                 * @since 3.8.0
    14211419                 *
    $document.ready( function() { 
    14271425                },
    14281426
    14291427                /**
    1430                  * @summary Disables sortables.
     1428                 * Disables sortables.
    14311429                 *
    14321430                 * @since 3.8.0
    14331431                 *
    $document.ready( function() { 
    14421440                },
    14431441
    14441442                /**
    1445                  * @summary Enables sortables.
     1443                 * Enables sortables.
    14461444                 *
    14471445                 * @since 3.8.0
    14481446                 *
    $document.ready( function() { 
    14581456        };
    14591457
    14601458        /**
    1461          * @summary Add an ARIA role `button` to elements that behave like UI controls when JavaScript is on.
     1459         * Add an ARIA role `button` to elements that behave like UI controls when JavaScript is on.
    14621460         *
    14631461         * @since 4.5.0
    14641462         *
    $document.ready( function() { 
    14731471        });
    14741472
    14751473        /**
    1476          * @summary Get the viewport width.
     1474         * Get the viewport width.
    14771475         *
    14781476         * @since 4.7.0
    14791477         *
    $document.ready( function() { 
    14921490        }
    14931491
    14941492        /**
    1495          * @summary Sets the admin menu collapsed/expanded state.
     1493         * Sets the admin menu collapsed/expanded state.
    14961494         *
    14971495         * Sets the global variable `menuState` and triggers a custom event passing
    14981496         * the current menu state.
    $document.ready( function() { 
    15191517        $document.on( 'wp-window-resized.set-menu-state', setMenuState );
    15201518
    15211519        /**
    1522          * @summary Sets ARIA attributes on the collapse/expand menu button.
     1520         * Sets ARIA attributes on the collapse/expand menu button.
    15231521         *
    15241522         * When the admin menu is open or folded, updates the `aria-expanded` and
    15251523         * `aria-label` attributes of the button to give feedback to assistive
    $document.ready( function() { 
    15821580        var timeout;
    15831581
    15841582        /**
    1585          * @summary Triggers the WP window-resize event.
     1583         * Triggers the WP window-resize event.
    15861584         *
    15871585         * @since 3.8.0
    15881586         *
    $document.ready( function() { 
    15931591        }
    15941592
    15951593        /**
    1596          * @summary Fires the trigger event again after 200 ms.
     1594         * Fires the trigger event again after 200 ms.
    15971595         *
    15981596         * @since 3.8.0
    15991597         *
  • src/wp-admin/js/custom-background.js

    diff --git src/wp-admin/js/custom-background.js src/wp-admin/js/custom-background.js
    index 9e96015e7..472ff321a 100644
     
    11/* global ajaxurl */
    22
    33/**
    4  * @summary Registers all events for customizing the background.
     4 * Registers all events for customizing the background.
    55 *
    66 * @since 3.0.0
    77 *
     
    1313                        bgImage = $( '#custom-background-image' );
    1414
    1515                /**
    16                  * @summary Instantiates the WordPress color picker and binds the change and clear events.
     16                 * Instantiates the WordPress color picker and binds the change and clear events.
    1717                 *
    1818                 * @since 3.5.0
    1919                 *
     
    2929                });
    3030
    3131                /**
    32                  * @summary Alters the background size CSS property whenever the background size input has changed.
     32                 * Alters the background size CSS property whenever the background size input has changed.
    3333                 *
    3434                 * @since 4.7.0
    3535                 *
     
    4040                });
    4141
    4242                /**
    43                  * @summary Alters the background position CSS property whenever the background position input has changed.
     43                 * Alters the background position CSS property whenever the background position input has changed.
    4444                 *
    4545                 * @since 4.7.0
    4646                 *
     
    5151                });
    5252
    5353                /**
    54                  * @summary Alters the background repeat CSS property whenever the background repeat input has changed.
     54                 * Alters the background repeat CSS property whenever the background repeat input has changed.
    5555                 *
    5656                 * @since 3.0.0
    5757                 *
     
    6262                });
    6363
    6464                /**
    65                  * @summary Alters the background attachment CSS property whenever the background attachment input has changed.
     65                 * Alters the background attachment CSS property whenever the background attachment input has changed.
    6666                 *
    6767                 * @since 4.7.0
    6868                 *
     
    7373                });
    7474
    7575                /**
    76                  * @summary Binds the event for opening the WP Media dialog.
     76                 * Binds the event for opening the WP Media dialog.
    7777                 *
    7878                 * @since 3.5.0
    7979                 *
     
    113113                        });
    114114
    115115                        /**
    116                          * @summary When an image is selected, run a callback.
     116                         * When an image is selected, run a callback.
    117117                         *
    118118                         * @since 3.5.0
    119119                         *
  • src/wp-admin/js/custom-header.js

    diff --git src/wp-admin/js/custom-header.js src/wp-admin/js/custom-header.js
    index ffe462354..5138e0cdb 100644
     
    11/* global isRtl */
    22
    33/**
    4  * @summary Initializes the custom header selection page.
     4 * Initializes the custom header selection page.
    55 *
    66 * @since 3.5.0
    77 *
     
    2727                });
    2828
    2929                /**
    30                  * @summary Opens the 'choose from library' frame and creates it if it doesn't
    31                  *          exist.
     30                 * Opens the 'choose from library' frame and creates it if it doesn't exist.
    3231                 *
    3332                 * @since 3.5.0
    3433                 * @deprecated 4.1.0
     
    6665                        });
    6766
    6867                        /**
    69                          * @summary Updates the window location to include the selected attachment.
     68                         * Updates the window location to include the selected attachment.
    7069                         *
    7170                         * @since 3.5.0
    7271                         * @deprecated 4.1.0
  • src/wp-admin/js/editor-expand.js

    diff --git src/wp-admin/js/editor-expand.js src/wp-admin/js/editor-expand.js
    index 3a5626c78..852ac6e54 100644
     
    77                $footer = $( '#wpfooter' );
    88
    99        /**
    10          * @summary Handles the resizing of the editor.
     10         * Handles the resizing of the editor.
    1111         *
    1212         * @since 4.0.0
    1313         *
     
    6060                        };
    6161
    6262                /**
    63                  * @summary Resizes textarea based on scroll height and width.
    64                  *
    65                  * Resizes textarea based on scroll height and width. Doesn't shrink the
    66                  * editor size below the 300px auto resize minimum height.
     63                 * Resizes textarea based on scroll height and width.
     64                 * Doesn't shrink the editor size below the 300px auto resize minimum height.
    6765                 *
    6866                 * @since 4.6.1
    6967                 *
     
    9088                }, 300 );
    9189
    9290                /**
    93                  * @summary Resizes the text editor depending on the old text length.
     91                 * Resizes the text editor depending on the old text length.
    9492                 *
    9593                 * If there is an mceEditor and it is hidden, it resizes the editor depending
    9694                 * on the old text length. If the current length of the text is smaller than
     
    123121                }
    124122
    125123                /**
    126                  * @summary Gets the height and widths of elements.
     124                 * Gets the height and widths of elements.
    127125                 *
    128126                 * Gets the heights of the window, the adminbar, the tools, the menu,
    129127                 * the visualTop, the textTop, the bottom, the statusbar and sideSortables
     
    158156
    159157                // We need to wait for TinyMCE to initialize.
    160158                /**
    161                  * @summary Binds all necessary functions for editor expand to the editor
    162                  * when the editor is initialized.
     159                 * Binds all necessary functions for editor expand to the editor when the editor is initialized.
    163160                 *
    164161                 * @since 4.0.0
    165162                 *
     
    172169                        // VK contains the type of key pressed. VK = virtual keyboard.
    173170                        var VK = window.tinymce.util.VK,
    174171                                /**
    175                                  * @summary Hides any float panel with a hover state. Additionally hides tooltips.
     172                                 * Hides any float panel with a hover state. Additionally hides tooltips.
    176173                                 *
    177174                                 * @returns {void}
    178175                                 */
     
    199196                        $menuBar = $contentWrap.find( '.mce-menubar' );
    200197
    201198                        /**
    202                          * @summary Gets the offset of the editor.
     199                         * Gets the offset of the editor.
    203200                         *
    204201                         * @returns {Number|Boolean} Returns the offset of the editor
    205202                         * or false if there is no offset height.
     
    232229                        }
    233230
    234231                        /**
    235                          * @summary Filters the special keys that should not be used for scrolling.
     232                         * Filters the special keys that should not be used for scrolling.
    236233                         *
    237234                         * @since 4.0.0
    238235                         *
     
    255252                        }
    256253
    257254                        /**
    258                          * @summary Makes sure the cursor is always visible in the editor.
     255                         * Makes sure the cursor is always visible in the editor.
    259256                         *
    260257                         * Makes sure the cursor is kept between the toolbars of the editor and scrolls
    261258                         * the window when the cursor moves out of the viewport to a wpview.
     
    322319                        }
    323320
    324321                        /**
    325                          * @summary If the editor is fullscreen, calls adjust.
     322                         * If the editor is fullscreen, calls adjust.
    326323                         *
    327324                         * @since 4.1.0
    328325                         *
     
    338335                        }
    339336
    340337                        /**
    341                          * @summary Shows the editor when scrolled.
     338                         * Shows the editor when scrolled.
    342339                         *
    343340                         * Binds the hideFloatPanels function on the window scroll.mce-float-panels event.
    344341                         * Executes the wpAutoResize on the active editor.
     
    357354                        }
    358355
    359356                        /**
    360                          * @summary Resizes the editor.
     357                         * Resizes the editor.
    361358                         *
    362359                         * Removes all functions from the window scroll.mce-float-panels event.
    363360                         * Resizes the text editor and scrolls to a position based on the pageXOffset and adminBarHeight.
     
    384381                        }
    385382
    386383                        /**
    387                          * @summary Toggles advanced states.
     384                         * Toggles advanced states.
    388385                         *
    389386                         * @since 4.1.0
    390387                         *
     
    395392                        }
    396393
    397394                        /**
    398                          * @summary Binds events of the editor and window.
     395                         * Binds events of the editor and window.
    399396                         *
    400397                         * @since 4.0.0
    401398                         *
     
    420417                        };
    421418
    422419                        /**
    423                          * @summary Unbinds the events of the editor and window.
     420                         * Unbinds the events of the editor and window.
    424421                         *
    425422                         * @since 4.0.0
    426423                         *
     
    447444                } );
    448445
    449446                /**
    450                  * @summary Adjusts the toolbars heights and positions.
    451                  *
    452                  * Adjusts the toolbar heights and positions based on the scroll position on the page,
     447                 * Adjusts the toolbars heights and positions based on the scroll position on the page,
    453448                 * the active editor mode and the heights of the editor, admin bar and side bar.
    454449                 *
    455450                 * @since 4.0.0
     
    764759                }
    765760
    766761                /**
    767                  * @summary Resizes the editor and adjusts the toolbars.
     762                 * Resizes the editor and adjusts the toolbars.
    768763                 *
    769764                 * @since 4.0.0
    770765                 *
     
    776771                }
    777772
    778773                /**
    779                  * @summary Runs the passed function with 500ms intervals.
     774                 * Runs the passed function with 500ms intervals.
    780775                 *
    781776                 * @since 4.0.0
    782777                 *
     
    791786                }
    792787
    793788                /**
    794                  * @summary Runs adjust after 100ms.
     789                 * Runs adjust after 100ms.
    795790                 *
    796791                 * @since 4.0.0
    797792                 *
     
    803798                }
    804799
    805800                /**
    806                  * @summary Binds editor expand events on elements.
     801                 * Binds editor expand events on elements.
    807802                 *
    808803                 * @since 4.0.0
    809804                 *
     
    873868                }
    874869
    875870                /**
    876                  * @summary Unbinds editor expand events.
     871                 * Unbinds editor expand events.
    877872                 *
    878873                 * @since 4.0.0
    879874                 *
     
    967962        } );
    968963
    969964        /**
    970          * @summary Handles the distraction free writing of TinyMCE.
     965         * Handles the distraction free writing of TinyMCE.
    971966         *
    972967         * @since 4.1.0
    973968         *
     
    10171012                } );
    10181013
    10191014                /**
    1020                  * @summary Recalculates the bottom and right position of the editor in the DOM.
     1015                 * Recalculates the bottom and right position of the editor in the DOM.
    10211016                 *
    10221017                 * @since 4.1.0
    10231018                 *
     
    10301025                }
    10311026
    10321027                /**
    1033                  * @summary Activates the distraction free writing mode.
     1028                 * Activates the distraction free writing mode.
    10341029                 *
    10351030                 * @since 4.1.0
    10361031                 *
     
    10461041                }
    10471042
    10481043                /**
    1049                  * @summary Deactivates the distraction free writing mode.
     1044                 * Deactivates the distraction free writing mode.
    10501045                 *
    10511046                 * @since 4.1.0
    10521047                 *
     
    10641059                }
    10651060
    10661061                /**
    1067                  * @summary Returns _isActive.
     1062                 * Returns _isActive.
    10681063                 *
    10691064                 * @since 4.1.0
    10701065                 *
     
    10751070                }
    10761071
    10771072                /**
    1078                  * @summary Binds events on the editor for distraction free writing.
     1073                 * Binds events on the editor for distraction free writing.
    10791074                 *
    10801075                 * @since 4.1.0
    10811076                 *
     
    10981093                }
    10991094
    11001095                /**
    1101                  * @summary Unbinds events on the editor for distraction free writing.
     1096                 * Unbinds events on the editor for distraction free writing.
    11021097                 *
    11031098                 * @since 4.1.0
    11041099                 *
     
    11211116                }
    11221117
    11231118                /**
    1124                  * @summary Binds or unbinds the editor expand events.
     1119                 * Binds or unbinds the editor expand events.
    11251120                 *
    11261121                 * @since 4.1.0
    11271122                 *
     
    11361131                }
    11371132
    11381133                /**
    1139                  * @summary Returns the value of _isOn.
     1134                 * Returns the value of _isOn.
    11401135                 *
    11411136                 * @since 4.1.0
    11421137                 *
     
    11471142                }
    11481143
    11491144                /**
    1150                  * @summary Fades out all elements except for the editor.
     1145                 * Fades out all elements except for the editor.
    11511146                 *
    11521147                 * The fading is done based on key presses and mouse movements.
    11531148                 * Also calls the fadeIn on certain key presses
     
    12901285                }
    12911286
    12921287                /**
    1293                  * @summary Fades all elements back in.
     1288                 * Fades all elements back in.
    12941289                 *
    12951290                 * @since 4.1.0
    12961291                 *
     
    13381333                }
    13391334
    13401335                /**
    1341                  * @summary Fades in if the focused element based on it position.
     1336                 * Fades in if the focused element based on it position.
    13421337                 *
    13431338                 * @since 4.1.0
    13441339                 *
     
    13601355                }
    13611356
    13621357                /**
    1363                  * @summary Fades out the admin bar based on focus on the admin bar.
     1358                 * Fades out the admin bar based on focus on the admin bar.
    13641359                 *
    13651360                 * @since 4.1.0
    13661361                 *
     
    13811376                }
    13821377
    13831378                /**
    1384                  * @summary Fades in the admin bar.
     1379                 * Fades in the admin bar.
    13851380                 *
    13861381                 * @since 4.1.0
    13871382                 *
     
    13961391                }
    13971392
    13981393                /**
    1399                  * @summary Fades out the edit slug box.
     1394                 * Fades out the edit slug box.
    14001395                 *
    14011396                 * @since 4.1.0
    14021397                 *
     
    14131408                }
    14141409
    14151410                /**
    1416                  * @summary Fades in the edit slug box.
     1411                 * Fades in the edit slug box.
    14171412                 *
    14181413                 * @since 4.1.0
    14191414                 *
     
    14301425                }
    14311426
    14321427                /**
    1433                  * @summary Triggers the toggle on Alt + Shift + W.
     1428                 * Triggers the toggle on Alt + Shift + W.
    14341429                 *
    14351430                 * Keycode 87 = w.
    14361431                 *
     
    14511446                }
    14521447
    14531448                /**
    1454                  * @summary Adds the distraction free writing button when setting up TinyMCE.
     1449                 * Adds the distraction free writing button when setting up TinyMCE.
    14551450                 *
    14561451                 * @since 4.1.0
    14571452                 *
     
    14921487                } );
    14931488
    14941489                /**
    1495                  * @summary Binds and unbinds events on the editor.
     1490                 * Binds and unbinds events on the editor.
    14961491                 *
    14971492                 * @since 4.1.0
    14981493                 *
     
    15491544                } );
    15501545
    15511546                /**
    1552                  * @summary Binds events on quicktags init.
     1547                 * Binds events on quicktags init.
    15531548                 *
    15541549                 * @since 4.1.0
    15551550                 *
  • src/wp-admin/js/editor.js

    diff --git src/wp-admin/js/editor.js src/wp-admin/js/editor.js
    index d52e6ba63..57bd3d881 100644
    window.wp = window.wp || {}; 
    44        wp.editor = wp.editor || {};
    55
    66        /**
    7          * @summary Utility functions for the editor.
     7         * Utility functions for the editor.
    88         *
    99         * @since 2.5.0
    1010         */
    window.wp = window.wp || {}; 
    1818                                $$ = tinymce.$;
    1919
    2020                                /**
    21                                  * @summary Handles onclick events for the Visual/Text tabs.
     21                                 * Handles onclick events for the Visual/Text tabs.
    2222                                 *
    2323                                 * @since 4.3.0
    2424                                 *
    window.wp = window.wp || {}; 
    3838                }
    3939
    4040                /**
    41                  * @summary Returns the height of the editor toolbar(s) in px.
     41                 * Returns the height of the editor toolbar(s) in px.
    4242                 *
    4343                 * @since 3.9.0
    4444                 *
    window.wp = window.wp || {}; 
    5858                }
    5959
    6060                /**
    61                  * @summary Switches the editor between Visual and Text mode.
     61                 * Switches the editor between Visual and Text mode.
    6262                 *
    6363                 * @since 2.5.0
    6464                 *
    window.wp = window.wp || {}; 
    184184                }
    185185
    186186                /**
    187                  * @summary Checks if a cursor is inside an HTML tag.
     187                 * Checks if a cursor is inside an HTML tag.
    188188                 *
    189189                 * In order to prevent breaking HTML tags when selecting text, the cursor
    190190                 * must be moved to either the start or end of the tag.
    window.wp = window.wp || {}; 
    227227                }
    228228
    229229                /**
    230                  * @summary Check if the cursor is inside a shortcode
     230                 * Checks if the cursor is inside a shortcode
    231231                 *
    232232                 * If the cursor is inside a shortcode wrapping tag, e.g. `[caption]` it's better to
    233233                 * move the selection marker to before or after the shortcode.
    window.wp = window.wp || {}; 
    281281                }
    282282
    283283                /**
    284                  * @summary Check if a shortcode has Live Preview enabled for it.
     284                 * Checks if a shortcode has Live Preview enabled for it.
    285285                 *
    286286                 * Previewable shortcodes here refers to shortcodes that have Live Preview enabled.
    287287                 *
    window.wp = window.wp || {}; 
    305305                }
    306306
    307307                /**
    308                  * @summary Get all shortcodes and their positions in the content
     308                 * Gets all shortcodes and their positions in the content
    309309                 *
    310310                 * This function returns all the shortcodes that could be found in the textarea content
    311311                 * along with their character positions and boundaries.
    window.wp = window.wp || {}; 
    414414                }
    415415
    416416                /**
    417                  * @summary Get adjusted selection cursor positions according to HTML tags/shortcodes
     417                 * Gets adjusted selection cursor positions according to HTML tags/shortcodes
    418418                 *
    419419                 * Shortcodes and HTML codes are a bit of a special case when selecting, since they may render
    420420                 * content in Visual mode. If we insert selection markers somewhere inside them, it's really possible
    window.wp = window.wp || {}; 
    497497                }
    498498
    499499                /**
    500                  * @summary Adds text selection markers in the editor textarea.
     500                 * Adds text selection markers in the editor textarea.
    501501                 *
    502502                 * Adds selection markers in the content of the editor `textarea`.
    503503                 * The method directly manipulates the `textarea` content, to allow TinyMCE plugins
    window.wp = window.wp || {}; 
    547547                }
    548548
    549549                /**
    550                  * @summary Focus the selection markers in Visual mode.
     550                 * Focuses the selection markers in Visual mode.
    551551                 *
    552552                 * The method checks for existing selection markers inside the editor DOM (Visual mode)
    553553                 * and create a selection between the two nodes using the DOM `createRange` selection API
    window.wp = window.wp || {}; 
    586586                }
    587587
    588588                /**
    589                  * @summary Remove selection marker and the parent node if it is an empty paragraph.
     589                 * Removes selection marker and the parent node if it is an empty paragraph.
    590590                 *
    591591                 * By default TinyMCE wraps loose inline tags in a `<p>`.
    592592                 * When removing selection markers an empty `<p>` may be left behind, remove it.
    window.wp = window.wp || {}; 
    605605                }
    606606
    607607                /**
    608                  * @summary Scrolls the content to place the selected element in the center of the screen.
     608                 * Scrolls the content to place the selected element in the center of the screen.
    609609                 *
    610610                 * Takes an element, that is usually the selection start element, selected in
    611611                 * `focusHTMLBookmarkInVisualEditor()` and scrolls the screen so the element appears roughly
    window.wp = window.wp || {}; 
    680680                }
    681681
    682682                /**
    683                  * @summary Finds the current selection position in the Visual editor.
     683                 * Finds the current selection position in the Visual editor.
    684684                 *
    685685                 * Find the current selection in the Visual editor by inserting marker elements at the start
    686686                 * and end of the selection.
    window.wp = window.wp || {}; 
    847847                }
    848848
    849849                /**
    850                  * @summary Selects text in the TinyMCE `textarea`.
     850                 * Selects text in the TinyMCE `textarea`.
    851851                 *
    852852                 * Selects the text in TinyMCE's textarea that's between `selection.start` and `selection.end`.
    853853                 *
    window.wp = window.wp || {}; 
    888888                } );
    889889
    890890                /**
    891                  * @summary Replaces <p> tags with two line breaks. "Opposite" of wpautop().
     891                 * Replaces <p> tags with two line breaks. "Opposite" of wpautop().
    892892                 *
    893893                 * Replaces <p> tags with two line breaks except where the <p> has attributes.
    894894                 * Unifies whitespace.
    window.wp = window.wp || {}; 
    10271027                }
    10281028
    10291029                /**
    1030                  * @summary Replaces two line breaks with a paragraph tag and one line break with a <br>.
     1030                 * Replaces two line breaks with a paragraph tag and one line break with a <br>.
    10311031                 *
    10321032                 * Similar to `wpautop()` in formatting.php.
    10331033                 *
    window.wp = window.wp || {}; 
    11561156                }
    11571157
    11581158                /**
    1159                  * @summary Fires custom jQuery events `beforePreWpautop` and `afterPreWpautop` when jQuery is available.
     1159                 * Fires custom jQuery events `beforePreWpautop` and `afterPreWpautop` when jQuery is available.
    11601160                 *
    11611161                 * @since 2.9.0
    11621162                 *
    window.wp = window.wp || {}; 
    11821182                }
    11831183
    11841184                /**
    1185                  * @summary Fires custom jQuery events `beforeWpautop` and `afterWpautop` when jQuery is available.
     1185                 * Fires custom jQuery events `beforeWpautop` and `afterWpautop` when jQuery is available.
    11861186                 *
    11871187                 * @since 2.9.0
    11881188                 *
  • src/wp-admin/js/image-edit.js

    diff --git src/wp-admin/js/image-edit.js src/wp-admin/js/image-edit.js
    index 0d8eaf081..057b47248 100644
     
    11/* global imageEditL10n, ajaxurl, confirm */
    22/**
    3  * @summary   The functions necessary for editing images.
     3 * The functions necessary for editing images.
    44 *
    5  * @since     2.9.0
     5 * @since 2.9.0
    66 */
    77
    88(function($) {
     
    1919        _view : false,
    2020
    2121        /**
    22          * @summary Converts a value to an integer.
     22         * Converts a value to an integer.
    2323         *
    2424         * @memberof imageEdit
    2525         * @since    2.9.0
     
    3737        },
    3838
    3939        /**
    40          * @summary Adds the disabled attribute and class to a single form element
    41          *          or a field set.
     40         * Adds the disabled attribute and class to a single form element or a field set.
    4241         *
    4342         * @memberof imageEdit
    4443         * @since    2.9.0
     
    6766        },
    6867
    6968        /**
    70          * @summary Initializes the image editor.
     69         * Initializes the image editor.
    7170         *
    7271         * @memberof imageEdit
    7372         * @since    2.9.0
     
    110109        },
    111110
    112111        /**
    113          * @summary Toggles the wait/load icon in the editor.
     112         * Toggles the wait/load icon in the editor.
    114113         *
    115114         * @memberof imageEdit
    116115         * @since    2.9.0
     
    131130        },
    132131
    133132        /**
    134          * @summary Shows or hides the image edit help box.
     133         * Shows or hides the image edit help box.
    135134         *
    136135         * @memberof imageEdit
    137136         * @since    2.9.0
     
    150149        },
    151150
    152151        /**
    153          * @summary Gets the value from the image edit target.
     152         * Gets the value from the image edit target.
    154153         *
    155154         * The image edit target contains the image sizes where the (possible) changes
    156155         * have to be applied to.
     
    168167        },
    169168
    170169        /**
    171          * @summary Recalculates the height or width and keeps the original aspect ratio.
     170         * Recalculates the height or width and keeps the original aspect ratio.
    172171         *
    173172         * If the original image size is exceeded a red exclamation mark is shown.
    174173         *
     
    206205        },
    207206
    208207        /**
    209          * @summary Gets the selected aspect ratio.
     208         * Gets the selected aspect ratio.
    210209         *
    211210         * @memberof imageEdit
    212211         * @since    2.9.0
     
    232231        },
    233232
    234233        /**
    235          * @summary Removes the last action from the image edit history
     234         * Removes the last action from the image edit history.
    236235         * The history consist of (edit) actions performed on the image.
    237236         *
    238237         * @memberof imageEdit
     
    296295                return '';
    297296        },
    298297        /**
    299          * @summary Binds the necessary events to the image.
     298         * Binds the necessary events to the image.
    300299         *
    301300         * When the image source is reloaded the image will be reloaded.
    302301         *
     
    372371                        .attr('src', ajaxurl + '?' + $.param(data));
    373372        },
    374373        /**
    375          * @summary Performs an image edit action.
     374         * Performs an image edit action.
    376375         *
    377376         * @memberof imageEdit
    378377         * @since    2.9.0
     
    439438        },
    440439
    441440        /**
    442          * @summary Stores the changes that are made to the image.
     441         * Stores the changes that are made to the image.
    443442         *
    444443         * @memberof imageEdit
    445444         * @since    2.9.0
     
    504503        },
    505504
    506505        /**
    507          * @summary Creates the image edit window.
     506         * Creates the image edit window.
    508507         *
    509508         * @memberof imageEdit
    510509         * @since    2.9.0
     
    561560        },
    562561
    563562        /**
    564          * @summary Initializes the cropping tool and sets a default cropping selection.
     563         * Initializes the cropping tool and sets a default cropping selection.
    565564         *
    566565         * @memberof imageEdit
    567566         * @since    2.9.0
     
    586585        },
    587586
    588587        /**
    589          * @summary Initializes the cropping tool.
     588         * Initializes the cropping tool.
    590589         *
    591590         * @memberof imageEdit
    592591         * @since    2.9.0
     
    612611                        minHeight: 3,
    613612
    614613                        /**
    615                          * @summary Sets the CSS styles and binds events for locking the aspect ratio.
     614                         * Sets the CSS styles and binds events for locking the aspect ratio.
    616615                         *
    617616                         * @param {jQuery} img The preview image.
    618617                         */
     
    623622                                $img.next().css( 'position', 'absolute' )
    624623                                        .nextAll( '.imgareaselect-outer' ).css( 'position', 'absolute' );
    625624                                /**
    626                                  * @summary Binds mouse down event to the cropping container.
     625                                 * Binds mouse down event to the cropping container.
    627626                                 *
    628627                                 * @returns {void}
    629628                                 */
     
    643642                        },
    644643
    645644                        /**
    646                          * @summary Event triggered when starting a selection.
     645                         * Event triggered when starting a selection.
    647646                         *
    648647                         * @returns {void}
    649648                         */
     
    651650                                imageEdit.setDisabled($('#imgedit-crop-sel-' + postid), 1);
    652651                        },
    653652                        /**
    654                          * @summary Event triggered when the selection is ended.
     653                         * Event triggered when the selection is ended.
    655654                         *
    656655                         * @param {object} img jQuery object representing the image.
    657656                         * @param {object} c   The selection.
     
    663662                        },
    664663
    665664                        /**
    666                          * @summary Event triggered when the selection changes.
     665                         * Event triggered when the selection changes.
    667666                         *
    668667                         * @param {object} img jQuery object representing the image.
    669668                         * @param {object} c   The selection.
     
    679678        },
    680679
    681680        /**
    682          * @summary Stores the current crop selection.
     681         * Stores the current crop selection.
    683682         *
    684683         * @memberof imageEdit
    685684         * @since    2.9.0
     
    710709
    711710
    712711        /**
    713          * @summary Closes the image editor.
     712         * Closes the image editor.
    714713         *
    715714         * @memberof imageEdit
    716715         * @since    2.9.0
     
    751750        },
    752751
    753752        /**
    754          * @summary Checks if the image edit history is saved.
     753         * Checks if the image edit history is saved.
    755754         *
    756755         * @memberof imageEdit
    757756         * @since    2.9.0
     
    775774        },
    776775
    777776        /**
    778          * @summary Adds an image edit action to the history.
     777         * Adds an image edit action to the history.
    779778         *
    780779         * @memberof imageEdit
    781780         * @since    2.9.0
     
    808807        },
    809808
    810809        /**
    811          * @summary Rotates the image.
     810         * Rotates the image.
    812811         *
    813812         * @memberof imageEdit
    814813         * @since    2.9.0
     
    829828        },
    830829
    831830        /**
    832          * @summary Flips the image.
     831         * Flips the image.
    833832         *
    834833         * @memberof imageEdit
    835834         * @since    2.9.0
     
    850849        },
    851850
    852851        /**
    853          * @summary Crops the image.
     852         * Crops the image.
    854853         *
    855854         * @memberof imageEdit
    856855         * @since    2.9.0
     
    879878        },
    880879
    881880        /**
    882          * @summary Undoes an image edit action.
     881         * Undoes an image edit action.
    883882         *
    884883         * @memberof imageEdit
    885884         * @since    2.9.0
     
    942941        },
    943942
    944943        /**
    945          * @summary Sets the selection for the height and width in pixels.
     944         * Sets the selection for the height and width in pixels.
    946945         *
    947946         * @memberof imageEdit
    948947         * @since    2.9.0
  • src/wp-admin/js/inline-edit-post.js

    diff --git src/wp-admin/js/inline-edit-post.js src/wp-admin/js/inline-edit-post.js
    index 0b3d6a881..5f9c2517d 100644
    var inlineEditPost; 
    2727        inlineEditPost = {
    2828
    2929        /**
    30          * @summary Initializes the inline and bulk post editor.
     30         * Initializes the inline and bulk post editor.
    3131         *
    3232         * Binds event handlers to the escape key to close the inline editor
    3333         * and to the save and close buttons. Changes DOM to be ready for inline
    var inlineEditPost; 
    4646                t.what = '#post-';
    4747
    4848                /**
    49                  * @summary Bind escape key to revert the changes and close the quick editor.
     49                 * Binds the escape key to revert the changes and close the quick editor.
    5050                 *
    5151                 * @returns {boolean} The result of revert.
    5252                 */
    var inlineEditPost; 
    5858                });
    5959
    6060                /**
    61                  * @summary Bind escape key to revert the changes and close the bulk editor.
     61                 * Binds the escape key to revert the changes and close the bulk editor.
    6262                 *
    6363                 * @returns {boolean} The result of revert.
    6464                 */
    var inlineEditPost; 
    7070                });
    7171
    7272                /**
    73                  * @summary Revert changes and close the quick editor if the cancel button is clicked.
     73                 * Reverts changes and close the quick editor if the cancel button is clicked.
    7474                 *
    7575                 * @returns {boolean} The result of revert.
    7676                 */
    var inlineEditPost; 
    7979                });
    8080
    8181                /**
    82                  * @summary Save changes in the quick editor if the save(named: update) button is clicked.
     82                 * Saves changes in the quick editor if the save(named: update) button is clicked.
    8383                 *
    8484                 * @returns {boolean} The result of save.
    8585                 */
    var inlineEditPost; 
    8888                });
    8989
    9090                /**
    91                  * @summary If enter is pressed, and the target is not the cancel button, save the post.
     91                 * If enter is pressed, and the target is not the cancel button, save the post.
    9292                 *
    9393                 * @returns {boolean} The result of save.
    9494                 */
    var inlineEditPost; 
    9999                });
    100100
    101101                /**
    102                  * @summary Revert changes and close the bulk editor if the cancel button is clicked.
     102                 * Reverts changes and close the bulk editor if the cancel button is clicked.
    103103                 *
    104104                 * @returns {boolean} The result of revert.
    105105                 */
    var inlineEditPost; 
    108108                });
    109109
    110110                /**
    111                  * @summary Disables the password input field when the private post checkbox is checked.
     111                 * Disables the password input field when the private post checkbox is checked.
    112112                 */
    113113                $('#inline-edit .inline-edit-private input[value="private"]').click( function(){
    114114                        var pw = $('input.inline-edit-password-input');
    var inlineEditPost; 
    120120                });
    121121
    122122                /**
    123                  * @summary Bind click event to the .editinline link which opens the quick editor.
     123                 * Binds click event to the .editinline link which opens the quick editor.
    124124                 */
    125125                $('#the-list').on( 'click', 'a.editinline', function( e ) {
    126126                        e.preventDefault();
    var inlineEditPost; 
    136136                $('select[name="_status"] option[value="future"]', bulkRow).remove();
    137137
    138138                /**
    139                  * @summary Adds onclick events to the apply buttons.
     139                 * Adds onclick events to the apply buttons.
    140140                 */
    141141                $('#doaction, #doaction2').click(function(e){
    142142                        var n;
    var inlineEditPost; 
    154154        },
    155155
    156156        /**
    157          * @summary Toggles the quick edit window.
    158          *
    159          * Hides the window when it's active and shows the window when inactive.
     157         * Toggles the quick edit window, hiding it when it's active and showing it when inactive.
    160158         *
    161159         * @memberof inlineEditPost
    162160         * @since 2.7.0
    var inlineEditPost; 
    169167        },
    170168
    171169        /**
    172          * @summary Creates the bulk editor row to edit multiple posts at once.
     170         * Creates the bulk editor row to edit multiple posts at once.
    173171         *
    174172         * @memberof inlineEditPost
    175173         * @since 2.7.0
    var inlineEditPost; 
    185183                $('#bulk-edit').addClass('inline-editor').show();
    186184
    187185                /**
    188                  * @summary Create a HTML div with the title and a delete link(cross-icon) for each selected post.
    189                  *
    190186                 * Get the selected posts based on the checked checkboxes in the post table.
    191187                 * Create a HTML div with the title and a link(delete-icon) for each selected post.
    192188                 */
    var inlineEditPost; 
    209205                // Add onclick events to the delete-icons in the bulk editors the post title list.
    210206                $('#bulk-titles').html(te);
    211207                /**
    212                  * @summary Binds on click events to the checkboxes before the posts in the table.
     208                 * Binds on click events to the checkboxes before the posts in the table.
    213209                 *
    214210                 * @listens click
    215211                 */
    var inlineEditPost; 
    241237        },
    242238
    243239        /**
    244          * @summary Creates a quick edit window for the post that has been clicked.
     240         * Creates a quick edit window for the post that has been clicked.
    245241         *
    246242         * @memberof inlineEditPost
    247243         * @since 2.7.0
    var inlineEditPost; 
    284280                        val = $('.'+fields[f], rowData);
    285281
    286282                        /**
    287                          * @summary Replaces the image for a Twemoji(Twitter emoji) with it's alternate text.
     283                         * Replaces the image for a Twemoji(Twitter emoji) with it's alternate text.
    288284                         *
    289285                         * @returns Alternate text from the image.
    290286                         */
    var inlineEditPost; 
    304300                }
    305301
    306302                /**
    307                  * @summary Creates the select boxes for the categories.
     303                 * Creates the select boxes for the categories.
    308304                 */
    309305                $('.post_category', rowData).each(function(){
    310306                        var taxname,
    var inlineEditPost; 
    317313                });
    318314
    319315                /**
    320                  * @summary Gets all the taxonomies for live auto-fill suggestions.
    321                  * When typing the name of a tag.
     316                 * Gets all the taxonomies for live auto-fill suggestions when typing the name of a tag.
    322317                 */
    323318                $('.tags_input', rowData).each(function(){
    324319                        var terms = $(this),
    var inlineEditPost; 
    381376        },
    382377
    383378        /**
    384          * @summary Saves the changes made in the quick edit window to the post.
     379         * Saves the changes made in the quick edit window to the post.
    385380         * AJAX saving is only for Quick Edit and not for bulk edit.
    386381         *
    387382         * @since 2.7.0
    var inlineEditPost; 
    447442        },
    448443
    449444        /**
    450          * @summary Hides and empties the Quick Edit and/or Bulk Edit windows.
     445         * Hides and empties the Quick Edit and/or Bulk Edit windows.
    451446         *
    452447         * @memberof    inlineEditPost
    453448         * @since 2.7.0
    var inlineEditPost; 
    488483        },
    489484
    490485        /**
    491          * @summary Gets the id for a the post that you want to quick edit from the row
    492          * in the quick edit table.
     486         * Gets the id for a the post that you want to quick edit from the row in the quick edit table.
    493487         *
    494488         * @memberof    inlineEditPost
    495489         * @since 2.7.0
  • src/wp-admin/js/inline-edit-tax.js

    diff --git src/wp-admin/js/inline-edit-tax.js src/wp-admin/js/inline-edit-tax.js
    index 797001780..47240f535 100644
    var inlineEditTax; 
    2121inlineEditTax = {
    2222
    2323        /**
    24          * @summary Initializes the inline taxonomy editor.
    25          *
    26          * Adds event handlers to be able to quick edit.
     24         * Initializes the inline taxonomy editor by adding event handlers to be able to quick edit.
    2725         *
    2826         * @since 2.7.0
    2927         *
    inlineEditTax = { 
    4240                        return false;
    4341                });
    4442
    45                 /*
    46                  * @summary Cancels inline editing when pressing escape inside the inline editor.
     43                /**
     44                 * Cancels inline editing when pressing escape inside the inline editor.
    4745                 *
    4846                 * @param {Object} e The keyup event that has been triggered.
    4947                 */
    inlineEditTax = { 
    5553                });
    5654
    5755                /**
    58                  * @summary Cancels inline editing when clicking the cancel button.
     56                 * Cancels inline editing when clicking the cancel button.
    5957                 */
    6058                $( '.cancel', row ).click( function() {
    6159                        return inlineEditTax.revert();
    6260                });
    6361
    6462                /**
    65                  * @summary Saves the inline edits when clicking the save button.
     63                 * Saves the inline edits when clicking the save button.
    6664                 */
    6765                $( '.save', row ).click( function() {
    6866                        return inlineEditTax.save(this);
    6967                });
    7068
    7169                /**
    72                  * @summary Saves the inline edits when pressing enter inside the inline editor.
     70                 * Saves the inline edits when pressing enter inside the inline editor.
    7371                 */
    7472                $( 'input, select', row ).keydown( function( e ) {
    7573                        // 13 = [enter]
    inlineEditTax = { 
    7977                });
    8078
    8179                /**
    82                  * @summary Saves the inline edits on submitting the inline edit form.
     80                 * Saves the inline edits on submitting the inline edit form.
    8381                 */
    8482                $( '#posts-filter input[type="submit"]' ).mousedown( function() {
    8583                        t.revert();
    inlineEditTax = { 
    149147        },
    150148
    151149        /**
    152          * @summary Saves the quick edit data.
    153          *
    154          * Saves the quick edit data to the server and replaces the table row with the
    155          * HTML retrieved from the server.
     150         * Saves the quick edit data to the server and replaces the table row with the HTML retrieved from the server.
    156151         *
    157152         * @since 2.7.0
    158153         *
    inlineEditTax = { 
    187182                // Do the ajax request to save the data to the server.
    188183                $.post( ajaxurl, params,
    189184                        /**
    190                          * @summary Handles the response from the server.
    191                          *
    192                          * Handles the response from the server, replaces the table row with the response
    193                          * from the server.
     185                         * Handles the response from the server, replaces the table row with the response from the server.
    194186                         *
    195187                         * @param {string} r The string with which to replace the table row.
    196188                         */
  • src/wp-admin/js/media.js

    diff --git src/wp-admin/js/media.js src/wp-admin/js/media.js
    index 4c1dc58fc..7102614ae 100644
     
    11/* global ajaxurl, attachMediaBoxL10n, _wpMediaGridSettings, showNotice */
    22
    33/**
    4  * @summary Creates a dialog containing posts that can have a particular media attached to it.
     4 * Creates a dialog containing posts that can have a particular media attached to it.
    55 *
    66 * @since 2.7.0
    77 *
    var findPosts; 
    1515( function( $ ){
    1616        findPosts = {
    1717                /**
    18                  * @summary Opens a dialog to attach media to a post.
    19                  *
    2018                 * Adds an overlay prior to retrieving a list of posts to attach the media to.
    2119                 *
    2220                 * @since 2.7.0
    var findPosts; 
    5957                },
    6058
    6159                /**
    62                  * @summary Clears the found posts lists before hiding the attach media dialog.
     60                 * Clears the found posts lists before hiding the attach media dialog.
    6361                 *
    6462                 * @since 2.7.0
    6563                 *
    var findPosts; 
    7472                },
    7573
    7674                /**
    77                  * @summary Binds a click event listener to the overlay which closes the attach media dialog.
     75                 * Binds a click event listener to the overlay which closes the attach media dialog.
    7876                 *
    7977                 * @since 3.5.0
    8078                 *
    var findPosts; 
    8987                },
    9088
    9189                /**
    92                  * @summary Retrieves and displays posts based on the search term.
     90                 * Retrieves and displays posts based on the search term.
    9391                 *
    9492                 * Sends a post request to the admin_ajax.php, requesting posts based on the search term provided by the user.
    9593                 * Defaults to all posts if no search term is provided.
    var findPosts; 
    133131        };
    134132
    135133        /**
    136          * @summary Initializes the file once the DOM is fully loaded and attaches events to the various form elements.
     134         * Initializes the file once the DOM is fully loaded and attaches events to the various form elements.
    137135         *
    138136         * @returns {void}
    139137         */
    var findPosts; 
    193191                });
    194192
    195193                /**
    196                  * @summary Enables clicking on the entire table row.
     194                 * Enables clicking on the entire table row.
    197195                 *
    198196                 * @returns {void}
    199197                 */
  • src/wp-admin/js/post.js

    diff --git src/wp-admin/js/post.js src/wp-admin/js/post.js
    index 662c62bff..1fc486459 100644
     
    33
    44/**
    55 * Contains all dynamic functionality needed on post and term pages.
    6  *
    7  * @summary Control page and term functionality.
    86 */
    97
    108var commentsBox, WPSetThumbnailHTML, WPSetThumbnailID, WPRemoveThumbnail, wptitlehint, makeSlugeditClickable, editPermalink;
    jQuery(document).ready( function($) { 
    928926        /**
    929927         * Handle the editing of the post_name. Create the required HTML elements and update the changes via AJAX.
    930928         *
    931          * @summary Permalink aka slug aka post_name editing
    932          *
    933929         * @global
    934930         *
    935931         * @returns void
    jQuery(document).ready( function($) { 
    10331029        });
    10341030
    10351031        /**
    1036          * Add screen reader text to the title prompt when needed.
    1037          *
    1038          * @summary Title screen reader text handler.
     1032         * Adds screen reader text to the title prompt when needed.
    10391033         *
    10401034         * @param {string} id Optional. HTML ID to add the screen reader helper text to.
    10411035         *
  • src/wp-admin/js/postbox.js

    diff --git src/wp-admin/js/postbox.js src/wp-admin/js/postbox.js
    index bbc73b2a6..8c944e801 100644
     
    22 * Contains the postboxes logic, opening and closing postboxes, reordering and saving
    33 * the state and ordering to the database.
    44 *
    5  * @summary Contains postboxes logic
    6  *
    75 * @since 2.5.0
    86 * @requires jQuery
    97 */
    var postboxes; 
    2826        postboxes = {
    2927
    3028                /**
    31                  * @summary Handles a click on either the postbox heading or the postbox open/close icon.
     29                 * Handles a click on either the postbox heading or the postbox open/close icon.
    3230                 *
    3331                 * Opens or closes the postbox. Expects `this` to equal the clicked element.
    3432                 * Calls postboxes.pbshow if the postbox has been opened, calls postboxes.pbhide
    var postboxes; 
    7674                        }
    7775
    7876                        /**
    79                          * @summary Fires when a postbox has been opened or closed.
     77                         * Fires when a postbox has been opened or closed.
    8078                         *
    8179                         * Contains a jQuery object with the relevant postbox element.
    8280                         *
    var postboxes; 
    115113                        });
    116114
    117115                        /**
    118                          * @summary Hides a postbox.
    119                          *
    120116                         * Event handler for the postbox dismiss button. After clicking the button
    121117                         * the postbox will be hidden.
    122118                         *
    var postboxes; 
    131127                        });
    132128
    133129                        /**
    134                          * @summary Hides the postbox element
    135                          *
    136130                         * Event handler for the screen options checkboxes. When a checkbox is
    137131                         * clicked this function will hide or show the relevant postboxes.
    138132                         *
    var postboxes; 
    169163                        });
    170164
    171165                        /**
    172                          * @summary Changes the amount of columns based on the layout preferences.
     166                         * Changes the amount of columns based on the layout preferences.
    173167                         *
    174168                         * @since 2.8.0
    175169                         *
    var postboxes; 
    186180                },
    187181
    188182                /**
    189                  * @summary Initializes all the postboxes, mainly their sortable behaviour.
     183                 * Initializes all the postboxes, mainly their sortable behaviour.
    190184                 *
    191185                 * @since 2.7.0
    192186                 * @memberof postboxes
    var postboxes; 
    265259                },
    266260
    267261                /**
    268                  * @summary Saves the state of the postboxes to the server.
    269                  *
    270262                 * Saves the state of the postboxes to the server. It sends two lists, one with
    271263                 * all the closed postboxes, one with all the hidden postboxes.
    272264                 *
    var postboxes; 
    297289                },
    298290
    299291                /**
    300                  * @summary Saves the order of the postboxes to the server.
    301                  *
    302292                 * Saves the order of the postboxes to the server. Sends a list of all postboxes
    303293                 * inside a sortable area to the server.
    304294                 *
    var postboxes; 
    326316                },
    327317
    328318                /**
    329                  * @summary Marks empty postbox areas.
     319                 * Marks empty postbox areas.
    330320                 *
    331321                 * Adds a message to empty sortable areas on the dashboard page. Also adds a
    332322                 * border around the side area on the post edit screen if there are no postboxes
    var postboxes; 
    362352                },
    363353
    364354                /**
    365                  * @summary Changes the amount of columns on the post edit page.
     355                 * Changes the amount of columns on the post edit page.
    366356                 *
    367357                 * @since 3.3.0
    368358                 * @memberof postboxes
    var postboxes; 
    389379                },
    390380
    391381                /**
    392                  * @summary Changes the amount of columns the postboxes are in based on the
    393                  *          current orientation of the browser.
     382                 * Changes the amount of columns the postboxes are in based on the current orientation of the browser.
    394383                 *
    395384                 * @since 3.3.0
    396385                 * @memberof postboxes
  • src/wp-admin/js/tags.js

    diff --git src/wp-admin/js/tags.js src/wp-admin/js/tags.js
    index c35efaa17..dc5e421c6 100644
     
    11/* global ajaxurl, wpAjax, tagsl10n, showNotice, validateForm */
    22/**
    3  * Contains logic for both adding and deleting tags. For deleting tags it makes a request
    4  * to the server to delete the tag. For adding tags it makes a request to the server to
    5  * add the tag.
     3 * Contains logic for deleting and adding tags.
    64 *
    7  * @summary Contains logic for deleting and adding tags
     5 * For deleting tags it makes a request to the server to delete the tag.
     6 * For adding tags it makes a request to the server to add the tag.
    87 */
    98
    109jQuery(document).ready(function($) {
    1110
    1211        /**
    13          * @summary Adds an event handler to the delete term link on the term overview page.
    14          *
    1512         * Adds an event handler to the delete term link on the term overview page.
    1613         * Cancels default event handling and event bubbling.
    1714         *
    jQuery(document).ready(function($) { 
    2926                        data = t.attr('href').replace(/[^?]*\?/, '').replace(/action=delete/, 'action=delete-tag');
    3027
    3128                        /**
    32                          * @summary Makes a request to the server to delete the term that
    33                          * corresponds to the delete term button.
     29                         * Makes a request to the server to delete the term that corresponds to the delete term button.
    3430                         *
    3531                         * @param {string} r The response from the server.
    3632                         *
    jQuery(document).ready(function($) { 
    4238                                        tr.fadeOut('normal', function(){ tr.remove(); });
    4339
    4440                                        /**
    45                                          * @summary Remove the term from the parent box and the tag cloud
     41                                         * Removes the term from the parent box and the tag cloud.
    4642                                         *
    4743                                         * `data.match(/tag_ID=(\d+)/)[1]` matches the term id from the data variable.
    4844                                         * This term id is then used to select the relevant HTML elements:
    jQuery(document).ready(function($) { 
    8783        });
    8884
    8985        /**
    90          * @summary Adds an event handler tot he form submit on the term overview page.
     86         * Adds an event handler to the form submit on the term overview page.
    9187         *
    9288         * Cancels default event handling and event bubbling.
    9389         *
  • src/wp-admin/js/word-count.js

    diff --git src/wp-admin/js/word-count.js src/wp-admin/js/word-count.js
    index 6b319ccf2..66a53c459 100644
     
    11/**
    22 * Word or character counting functionality. Count words or characters in a provided text string.
    33 *
    4  * @summary   Count words or characters in a text.
    5  *
    64 * @namespace wp.utils
    75 * @since     2.6.0
    86 */
     
    143141        /**
    144142         * Counts the number of words (or other specified type) in the specified text.
    145143         *
    146          * @summary  Count the number of elements in a text.
    147          *
    148144         * @since    2.6.0
    149145         * @memberof wp.utils.wordcounter
    150146         *
  • src/wp-content/themes/twentyfifteen/js/functions.js

    diff --git src/wp-content/themes/twentyfifteen/js/functions.js src/wp-content/themes/twentyfifteen/js/functions.js
    index 2da5cbc34..b9dddc85b 100644
     
    7777        } )();
    7878
    7979        /**
    80          * @summary Add or remove ARIA attributes.
     80         * Add or remove ARIA attributes.
     81         *
    8182         * Uses jQuery's width() function to determine the size of the window and add
    8283         * the default ARIA attributes for the menu toggle if it's visible.
    8384         * @since Twenty Fifteen 1.1
  • src/wp-content/themes/twentyfourteen/js/functions.js

    diff --git src/wp-content/themes/twentyfourteen/js/functions.js src/wp-content/themes/twentyfourteen/js/functions.js
    index a21849ec3..ac4629d77 100644
     
    122122        } );
    123123
    124124        /**
    125          * @summary Add or remove ARIA attributes.
     125         * Add or remove ARIA attributes.
     126         *
    126127         * Uses jQuery's width() function to determine the size of the window and add
    127128         * the default ARIA attributes for the menu toggle if it's visible.
    128129         * @since Twenty Fourteen 1.4
  • src/wp-content/themes/twentythirteen/js/functions.js

    diff --git src/wp-content/themes/twentythirteen/js/functions.js src/wp-content/themes/twentythirteen/js/functions.js
    index 88e8d0b5a..a8600df66 100644
     
    7575        } )();
    7676
    7777        /**
    78          * @summary Add or remove ARIA attributes.
     78         * Add or remove ARIA attributes.
     79         *
    7980         * Uses jQuery's width() function to determine the size of the window and add
    8081         * the default ARIA attributes for the menu toggle if it's visible.
     82         *
    8183         * @since Twenty Thirteen 1.5
    8284         */
    8385        function onResizeARIA() {
     
    162164                        } );
    163165                }
    164166        } );
    165 } )( jQuery );
    166  No newline at end of file
     167} )( jQuery );
  • src/wp-includes/js/autosave.js

    diff --git src/wp-includes/js/autosave.js src/wp-includes/js/autosave.js
    index afd51fbbd..1250c064e 100644
    window.autosave = function() { 
    55};
    66
    77/**
    8  * @summary Adds autosave to the window object on dom ready.
     8 * Adds autosave to the window object on dom ready.
    99 *
    1010 * @since 3.9.0
    1111 *
    window.autosave = function() { 
    1515 */
    1616( function( $, window ) {
    1717        /**
    18          * @summary Auto saves the post.
     18         * Auto saves the post.
    1919         *
    2020         * @since 3.9.0
    2121         *
    window.autosave = function() { 
    3636                        $document = $(document);
    3737
    3838                /**
    39                  * @summary Returns the data saved in both local and remote autosave.
     39                 * Returns the data saved in both local and remote autosave.
    4040                 *
    4141                 * @since 3.9.0
    4242                 *
    window.autosave = function() { 
    9999                }
    100100
    101101                /**
    102                  * @summary Concatenates the title, content and excerpt.
    103                  *
    104                  * This is used to track changes when auto-saving.
     102                 * Concatenates the title, content and excerpt. This is used to track changes when auto-saving.
    105103                 *
    106104                 * @since 3.9.0
    107105                 *
    window.autosave = function() { 
    118116                }
    119117
    120118                /**
    121                  * @summary Disables save buttons.
     119                 * Disables save buttons.
    122120                 *
    123121                 * @since 3.9.0
    124122                 *
    window.autosave = function() { 
    132130                }
    133131
    134132                /**
    135                  * @summary Enables save buttons.
     133                 * Enables save buttons.
    136134                 *
    137135                 * @since 3.9.0
    138136                 *
    window.autosave = function() { 
    143141                }
    144142
    145143                /**
    146                  * @summary Gets the content editor.
     144                 * Gets the content editor.
    147145                 *
    148146                 * @since 4.6.0
    149147                 *
    window.autosave = function() { 
    155153                }
    156154
    157155                /**
    158                  * @summary Autosave in localStorage.
     156                 * Autosave in localStorage.
    159157                 *
    160158                 * @since 3.9.0
    161159                 *
    window.autosave = function() { 
    176174                                isSuspended = false;
    177175
    178176                        /**
    179                          * @summary Checks if the browser supports sessionStorage and it's not disabled.
     177                         * Checks if the browser supports sessionStorage and it's not disabled.
    180178                         *
    181179                         * @since 3.9.0
    182180                         *
    window.autosave = function() { 
    197195                        }
    198196
    199197                        /**
    200                          * @summary Initializes the local storage.
     198                         * Initializes the local storage.
    201199                         *
    202200                         * @since 3.9.0
    203201                         *
    window.autosave = function() { 
    221219                        }
    222220
    223221                        /**
    224                          * @summary Sets the storage for this blog.
    225                          *
    226                          * Confirms that the data was saved successfully.
     222                         * Sets the storage for this blog. Confirms that the data was saved successfully.
    227223                         *
    228224                         * @since 3.9.0
    229225                         *
    window.autosave = function() { 
    242238                        }
    243239
    244240                        /**
    245                          * @summary Gets the saved post data for the current post.
     241                         * Gets the saved post data for the current post.
    246242                         *
    247243                         * @since 3.9.0
    248244                         *
    window.autosave = function() { 
    259255                        }
    260256
    261257                        /**
    262                          * @summary Sets (save or delete) post data in the storage.
     258                         * Sets (save or delete) post data in the storage.
    263259                         *
    264260                         * If stored_data evaluates to 'false' the storage key for the current post will be removed.
    265261                         *
    window.autosave = function() { 
    288284                        }
    289285
    290286                        /**
    291                          * @summary Sets isSuspended to true.
     287                         * Sets isSuspended to true.
    292288                         *
    293289                         * @since 3.9.0
    294290                         *
    window.autosave = function() { 
    299295                        }
    300296
    301297                        /**
    302                          * @summary Sets isSuspended to false.
     298                         * Sets isSuspended to false.
    303299                         *
    304300                         * @since 3.9.0
    305301                         *
    window.autosave = function() { 
    310306                        }
    311307
    312308                        /**
    313                          * @summary Saves post data for the current post.
     309                         * Saves post data for the current post.
    314310                         *
    315311                         * Runs on a 15 sec. interval, saves when there are differences in the post title or content.
    316312                         * When the optional data is provided, updates the last saved post data.
    window.autosave = function() { 
    359355                        }
    360356
    361357                        /**
    362                          * @summary Initializes the auto save function.
     358                         * Initializes the auto save function.
    363359                         *
    364360                         * Checks whether the editor is active or not to use the editor events
    365361                         * to autosave, or uses the values from the elements to autosave.
    window.autosave = function() { 
    419415                        }
    420416
    421417                        /**
    422                          * @summary Compares 2 strings.
    423                          *
    424                          * Removes whitespaces in the strings before comparing them.
     418                         * Compares 2 strings. Removes whitespaces in the strings before comparing them.
    425419                         *
    426420                         * @since 3.9.0
    427421                         *
    window.autosave = function() { 
    438432                        }
    439433
    440434                        /**
    441                          * @summary Checks if the saved data for the current post (if any) is different
    442                          * than the loaded post data on the screen.
     435                         * Checks if the saved data for the current post (if any) is different than the loaded post data on the screen.
    443436                         *
    444437                         * Shows a standard message letting the user restore the post data if different.
    445438                         *
    window.autosave = function() { 
    507500                        }
    508501
    509502                        /**
    510                          * @summary Restores the current title, content and excerpt from postData.
     503                         * Restores the current title, content and excerpt from postData.
    511504                         *
    512505                         * @since 3.9.0
    513506                         *
    window.autosave = function() { 
    575568                }
    576569
    577570                /**
    578                  * @summary Auto saves the post on the server.
     571                 * Auto saves the post on the server.
    579572                 *
    580573                 * @since 3.9.0
    581574                 *
    window.autosave = function() { 
    596589
    597590
    598591                        /**
    599                          * @summary  Blocks saving for the next 10 seconds.
     592                         * Blocks saving for the next 10 seconds.
    600593                         *
    601594                         * @since 3.9.0
    602595                         *
    window.autosave = function() { 
    612605                        }
    613606
    614607                        /**
    615                          * @summary Sets isSuspended to true.
     608                         * Sets isSuspended to true.
    616609                         *
    617610                         * @since 3.9.0
    618611                         *
    window.autosave = function() { 
    623616                        }
    624617
    625618                        /**
    626                          * @summary Sets isSuspended to false.
     619                         * Sets isSuspended to false.
    627620                         *
    628621                         * @since 3.9.0
    629622                         *
    window.autosave = function() { 
    634627                        }
    635628
    636629                        /**
    637                          * @summary Triggers the autosave with the post data.
     630                         * Triggers the autosave with the post data.
    638631                         *
    639632                         * @since 3.9.0
    640633                         *
    window.autosave = function() { 
    658651                        }
    659652
    660653                        /**
    661                          * @summary Saves immediately.
     654                         * Saves immediately.
    662655                         *
    663656                         * Resets the timing and tells heartbeat to connect now.
    664657                         *
    window.autosave = function() { 
    672665                        }
    673666
    674667                        /**
    675                          * @summary Checks if the post content in the textarea has changed since page load.
     668                         * Checks if the post content in the textarea has changed since page load.
    676669                         *
    677670                         * This also happens when TinyMCE is active and editor.save() is triggered by
    678671                         * wp.autosave.getPostData().
    window.autosave = function() { 
    686679                        }
    687680
    688681                        /**
    689                          * @summary Checks if the post can be saved or not.
     682                         * Checks if the post can be saved or not.
    690683                         *
    691684                         * If the post hasn't changed or it cannot be updated,
    692685                         * because the autosave is blocked or suspended, the function returns false.
    window.autosave = function() { 
    733726                        }
    734727
    735728                        /**
    736                          * @summary Sets the next run, based on the autosave interval.
     729                         * Sets the next run, based on the autosave interval.
    737730                         *
    738731                         * @private
    739732                         *
    window.autosave = function() { 
    746739                        }
    747740
    748741                        /**
    749                          * @summary Sets the autosaveData on the autosave heartbeat.
     742                         * Sets the autosaveData on the autosave heartbeat.
    750743                         *
    751744                         * @since 3.9.0
    752745                         *
    window.autosave = function() { 
    760753                                }
    761754
    762755                                /**
    763                                  * @summary Triggers the autosave of the post with the autosave data
    764                                  * on the autosave heartbeat.
     756                                 * Triggers the autosave of the post with the autosave data on the autosave heartbeat.
    765757                                 *
    766758                                 * @since 3.9.0
    767759                                 *
    window.autosave = function() { 
    772764                                        response( data.wp_autosave );
    773765                                }
    774766                                /**
    775                                  * @summary Disables buttons and throws a notice when the connection is lost.
     767                                 * Disables buttons and throws a notice when the connection is lost.
    776768                                 *
    777769                                 * @since 3.9.0
    778770                                 *
    window.autosave = function() { 
    793785                                }
    794786
    795787                                /**
    796                                  * @summary Enables buttons when the connection is restored.
     788                                 * Enables buttons when the connection is restored.
    797789                                 *
    798790                                 * @since 3.9.0
    799791                                 *
    window.autosave = function() { 
    816808                }
    817809
    818810                /**
    819                  * @summary Sets the autosave time out.
     811                 * Sets the autosave time out.
    820812                 *
    821813                 * Wait for TinyMCE to initialize plus 1 second. for any external css to finish loading,
    822814                 * then save to the textarea before setting initialCompareString.
  • src/wp-includes/js/comment-reply.js

    diff --git src/wp-includes/js/comment-reply.js src/wp-includes/js/comment-reply.js
    index 55a4e9c9b..21427275a 100644
     
    11/**
    2  * @summary Handles the addition of the comment form.
     2 * Handles the addition of the comment form.
    33 *
    44 * @since 2.7.0
    55 *
  • src/wp-includes/js/media-audiovideo.js

    diff --git src/wp-includes/js/media-audiovideo.js src/wp-includes/js/media-audiovideo.js
    index e939d4945..58abf9273 100644
    var media = wp.media, 
    7373
    7474/**
    7575 *
    76  * @summary Defines the wp.media.mixin object.
     76 * Defines the wp.media.mixin object.
    7777 *
    7878 * @mixin
    7979 *
    wp.media.mixin = { 
    8383        mejsSettings: baseSettings,
    8484
    8585        /**
    86          * @summary Pauses and removes all players.
     86         * Pauses and removes all players.
    8787         *
    8888         * @since 4.2.0
    8989         *
    wp.media.mixin = { 
    101101        },
    102102
    103103        /**
    104          * @summary Removes the player.
     104         * Removes the player.
    105105         *
    106106         * Override the MediaElement method for removing a player.
    107107         * MediaElement tries to pull the audio/video tag out of
    wp.media.mixin = { 
    147147
    148148        /**
    149149         *
    150          * @summary Removes and resets all players.
     150         * Removes and resets all players.
    151151         *
    152152         * Allows any class that has set 'player' to a MediaElementPlayer
    153153         * instance to remove the player when listening to events.
    wp.media.mixin = { 
    168168};
    169169
    170170/**
    171  * @summary Shortcode modeling for playlists.
     171 * Shortcode modeling for playlists.
    172172 *
    173173 * @since 4.2.0
    174174 */
    wp.media.playlist = new wp.media.collection({ 
    187187});
    188188
    189189/**
    190  * @summary Shortcode modeling for audio.
     190 * Shortcode modeling for audio.
    191191 *
    192192 * `edit()` prepares the shortcode for the media modal.
    193193 * `shortcode()` builds the new shortcode after an update.
    wp.media.audio = { 
    209209        },
    210210
    211211        /**
    212          * @summary Instantiates a new media object with the next matching shortcode.
     212         * Instantiates a new media object with the next matching shortcode.
    213213         *
    214214         * @since 4.2.0
    215215         *
    wp.media.audio = { 
    229229        },
    230230
    231231        /**
    232          * @summary Generates an audio shortcode.
     232         * Generates an audio shortcode.
    233233         *
    234234         * @since 4.2.0
    235235         *
    wp.media.audio = { 
    259259};
    260260
    261261/**
    262  * @summary Shortcode modeling for video.
     262 * Shortcode modeling for video.
    263263 *
    264264 *  `edit()` prepares the shortcode for the media modal.
    265265 *  `shortcode()` builds the new shortcode after update.
    wp.media.video = { 
    284284        },
    285285
    286286        /**
    287          * @summary Instantiates a new media object with the next matching shortcode.
     287         * Instantiates a new media object with the next matching shortcode.
    288288         *
    289289         * @since 4.2.0
    290290         *
    wp.media.video = { 
    309309        },
    310310
    311311        /**
    312          * @summary Generates an video shortcode.
     312         * Generates an video shortcode.
    313313         *
    314314         * @since 4.2.0
    315315         *
    module.exports = VideoDetails; 
    11021102
    11031103
    11041104/***/ })
    1105 /******/ ]);
    1106  No newline at end of file
     1105/******/ ]);
  • src/wp-includes/js/media-views.js

    diff --git src/wp-includes/js/media-views.js src/wp-includes/js/media-views.js
    index 9dbdd5ecb..8e0525116 100644
    Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe 
    23202320        },
    23212321
    23222322        /**
    2323          * @summary Opens the crop image window.
    2324          *
    2325          * Shows the crop image window when called from the Add new image button.
     2323         * Opens the crop image window. Shows the crop image window when called from the Add new image button.
    23262324         *
    23272325         * @since 4.2.0
    23282326         *
    Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe 
    23352333        },
    23362334
    23372335        /**
    2338          * @summary Changes the state of the toolbar window to browse mode.
     2336         * Changes the state of the toolbar window to browse mode.
    23392337         *
    23402338         * @since 4.2.0
    23412339         *
    Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe 
    23462344        },
    23472345
    23482346        /**
    2349          * @summary Creates the crop image window.
    2350          *
    2351          * Initialized when clicking on the Select and Crop button.
     2347         * Creates the crop image window. Initialized when clicking on the Select and Crop button.
    23522348         *
    23532349         * @since 4.2.0
    23542350         *
    Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe 
    23672363        },
    23682364
    23692365        /**
    2370          * @summary Removes the image selection and closes the cropping window.
     2366         * Removes the image selection and closes the cropping window.
    23712367         *
    23722368         * @since 4.2.0
    23732369         *
    Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe 
    23812377        },
    23822378
    23832379        /**
    2384          * @summary Checks if cropping can be skipped and creates crop toolbar accordingly.
     2380         * Checks if cropping can be skipped and creates crop toolbar accordingly.
    23852381         *
    23862382         * @since 4.2.0
    23872383         *
    Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe 
    24432439        },
    24442440
    24452441        /**
    2446          * @summary Creates an object with the image attachment and crop properties.
     2442         * Creates an object with the image attachment and crop properties.
    24472443         *
    24482444         * @since 4.2.0
    24492445         *
    module.exports = Spinner; 
    92529248
    92539249
    92549250/***/ })
    9255 /******/ ]));
    9256  No newline at end of file
     9251/******/ ]));
  • src/wp-includes/js/media/audiovideo.manifest.js

    diff --git src/wp-includes/js/media/audiovideo.manifest.js src/wp-includes/js/media/audiovideo.manifest.js
    index 7981aa75a..c1e4c59f8 100644
    var media = wp.media, 
    44
    55/**
    66 *
    7  * @summary Defines the wp.media.mixin object.
     7 * Defines the wp.media.mixin object.
    88 *
    99 * @mixin
    1010 *
    wp.media.mixin = { 
    1414        mejsSettings: baseSettings,
    1515
    1616        /**
    17          * @summary Pauses and removes all players.
     17         * Pauses and removes all players.
    1818         *
    1919         * @since 4.2.0
    2020         *
    wp.media.mixin = { 
    3232        },
    3333
    3434        /**
    35          * @summary Removes the player.
     35         * Removes the player.
    3636         *
    3737         * Override the MediaElement method for removing a player.
    3838         * MediaElement tries to pull the audio/video tag out of
    wp.media.mixin = { 
    7878
    7979        /**
    8080         *
    81          * @summary Removes and resets all players.
     81         * Removes and resets all players.
    8282         *
    8383         * Allows any class that has set 'player' to a MediaElementPlayer
    8484         * instance to remove the player when listening to events.
    wp.media.mixin = { 
    9999};
    100100
    101101/**
    102  * @summary Shortcode modeling for playlists.
     102 * Shortcode modeling for playlists.
    103103 *
    104104 * @since 4.2.0
    105105 */
    wp.media.playlist = new wp.media.collection({ 
    118118});
    119119
    120120/**
    121  * @summary Shortcode modeling for audio.
     121 * Shortcode modeling for audio.
    122122 *
    123123 * `edit()` prepares the shortcode for the media modal.
    124124 * `shortcode()` builds the new shortcode after an update.
    wp.media.audio = { 
    140140        },
    141141
    142142        /**
    143          * @summary Instantiates a new media object with the next matching shortcode.
     143         * Instantiates a new media object with the next matching shortcode.
    144144         *
    145145         * @since 4.2.0
    146146         *
    wp.media.audio = { 
    160160        },
    161161
    162162        /**
    163          * @summary Generates an audio shortcode.
     163         * Generates an audio shortcode.
    164164         *
    165165         * @since 4.2.0
    166166         *
    wp.media.audio = { 
    190190};
    191191
    192192/**
    193  * @summary Shortcode modeling for video.
     193 * Shortcode modeling for video.
    194194 *
    195195 *  `edit()` prepares the shortcode for the media modal.
    196196 *  `shortcode()` builds the new shortcode after update.
    wp.media.video = { 
    215215        },
    216216
    217217        /**
    218          * @summary Instantiates a new media object with the next matching shortcode.
     218         * Instantiates a new media object with the next matching shortcode.
    219219         *
    220220         * @since 4.2.0
    221221         *
    wp.media.video = { 
    240240        },
    241241
    242242        /**
    243          * @summary Generates an video shortcode.
     243         * Generates an video shortcode.
    244244         *
    245245         * @since 4.2.0
    246246         *
  • src/wp-includes/js/media/controllers/cropper.js

    diff --git src/wp-includes/js/media/controllers/cropper.js src/wp-includes/js/media/controllers/cropper.js
    index be4b7bc53..3418064a6 100644
    Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe 
    2727        },
    2828
    2929        /**
    30          * @summary Opens the crop image window.
    31          *
    3230         * Shows the crop image window when called from the Add new image button.
    3331         *
    3432         * @since 4.2.0
    Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe 
    4240        },
    4341
    4442        /**
    45          * @summary Changes the state of the toolbar window to browse mode.
     43         * Changes the state of the toolbar window to browse mode.
    4644         *
    4745         * @since 4.2.0
    4846         *
    Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe 
    5351        },
    5452
    5553        /**
    56          * @summary Creates the crop image window.
     54         * Creates the crop image window.
    5755         *
    5856         * Initialized when clicking on the Select and Crop button.
    5957         *
    Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe 
    7472        },
    7573
    7674        /**
    77          * @summary Removes the image selection and closes the cropping window.
     75         * Removes the image selection and closes the cropping window.
    7876         *
    7977         * @since 4.2.0
    8078         *
    Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe 
    8886        },
    8987
    9088        /**
    91          * @summary Checks if cropping can be skipped and creates crop toolbar accordingly.
     89         * Checks if cropping can be skipped and creates crop toolbar accordingly.
    9290         *
    9391         * @since 4.2.0
    9492         *
    Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe 
    150148        },
    151149
    152150        /**
    153          * @summary Creates an object with the image attachment and crop properties.
     151         * Creates an object with the image attachment and crop properties.
    154152         *
    155153         * @since 4.2.0
    156154         *