WordPress.org
Get WordPress

Make WordPress Core

Changeset 42411


Ignore:
Timestamp:
12/18/2017 02:13:58 PM (7 years ago)
Author:
atimmer
Message:

Docs: Remove @summary tags from JSDoc.

As decided in the JavaScript core chat. With a few reasons:

  • It is visually cleaner when reading the source.
  • This bring the JavaScript documentation closer to the PHP documentation.

The only disadvantage is that the JSDoc parser doesn't split out the summary and the description in the new format. We've decided to solve this when building the JavaScript documentation parser.

Props herregroen.
Fixes #42901.

Location:
trunk/src
Files:
24 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/js/color-picker.js

    r42403 r42411  
    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     *
    … …  
    3230        },
    3331        /**
    34          * @summary Creates a color picker that only allows you to adjust the hue.
     32         * Creates a color picker that only allows you to adjust the hue.
    3533         *
    3634         * @since 3.5.0
    … …  
    5755                color: color,
    5856                /**
    59                  * @summary Handles the onChange event if one has been defined in the options.
     57                 * Handles the onChange event if one has been defined in the options.
    6058                 *
    6159                 * @ignore
    … …  
    7674        },
    7775        /**
    78          * @summary Creates the color picker.
    79          *
    8076         * Creates the color picker, sets default values, css classes and wraps it all in HTML.
    8177         *
    … …  
    177173                palettes: self.options.palettes,
    178174                /**
    179                  * @summary Handles the onChange event if one has been defined in the options.
    180                  *
    181175                 * Handles the onChange event if one has been defined in the options and additionally
    182176                 * sets the background color for the toggler element.
    … …  
    209203        },
    210204        /**
    211          * @summary Binds event listeners to the color picker.
     205         * Binds event listeners to the color picker.
    212206         *
    213207         * @since 3.5.0
    … …  
    221215
    222216            /**
    223              * @summary Prevent any clicks inside this widget from leaking to the top and closing it.
     217             * Prevent any clicks inside this widget from leaking to the top and closing it.
    224218             *
    225219             * @since 3.5.0
    … …  
    234228
    235229            /**
    236              * @summary Open or close the color picker depending on the class.
     230             * Open or close the color picker depending on the class.
    237231             *
    238232             * @since 3.5
    … …  
    247241
    248242            /**
    249              * @summary Checks if value is empty when changing the color in the color picker.
    250              *
    251243             * Checks if value is empty when changing the color in the color picker.
    252244             * If so, the background color is cleared.
    … …  
    272264
    273265            /**
    274              * @summary Enables the user to clear or revert the color in the color picker.
    275              *
    276266             * Enables the user to either clear the color in the color picker or revert back to the default color.
    277267             *
    … …  
    296286        },
    297287        /**
    298          * @summary Opens the color picker dialog.
     288         * Opens the color picker dialog.
    299289         *
    300290         * @since 3.5.0
    … …  
    312302        },
    313303        /**
    314          * @summary Closes the color picker dialog.
     304         * Closes the color picker dialog.
    315305         *
    316306         * @since 3.5.0
    … …  
    328318        },
    329319        /**
    330          * @summary Returns iris object or sets new color.
    331          *
    332320         * Returns the iris object if no new color is provided. If a new color is provided, it sets the new color.
    333321         *
    … …  
    345333        },
    346334        /**
    347          * @summary Returns iris object or sets new default color.
    348          *
    349335         * Returns the iris object if no new default color is provided.
    350336         * If a new default color is provided, it sets the new default color.

  • trunk/src/wp-admin/js/comment.js

    r40913 r42411  
    22
    33/**
    4  * @summary Binds to the document ready event.
     4 * Binds to the document ready event.
    55 *
    66 * @since 2.5.0
    … …  
    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
    … …  
    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
    … …  
    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

  • trunk/src/wp-admin/js/common.js

    r42357 r42411  
    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.
    … …  
    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
    … …  
    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
    … …  
    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.
    … …  
    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
    … …  
    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
    … …  
    100100
    101101    /**
    102      * @summary Get all hidden columns.
     102     * Gets all hidden columns.
    103103     *
    104104     * @since 3.0.0
    … …  
    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
    … …  
    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
    … …  
    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
    … …  
    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
    … …  
    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
    … …  
    194194
    195195    /**
    196      * @summary Shows an alert message.
     196     * Shows an alert message.
    197197     *
    198198     * @since 2.7.0
    … …  
    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
    … …  
    222222
    223223    /**
    224      * @summary Initializes the screen meta options panel.
     224     * Initializes the screen meta options panel.
    225225     *
    226226     * @since 3.2.0
    … …  
    237237
    238238    /**
    239      * @summary Toggles the screen meta options panel.
     239     * Toggles the screen meta options panel.
    240240     *
    241241     * @since 3.2.0
    … …  
    256256
    257257    /**
    258      * @summary Opens the screen meta options panel.
     258     * Opens the screen meta options panel.
    259259     *
    260260     * @since 3.2.0
    … …  
    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
    … …  
    287287
    288288    /**
    289      * @summary Closes the screen meta options panel.
     289     * Closes the screen meta options panel.
    290290     *
    291291     * @since 3.2.0
    … …  
    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
    … …  
    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.
    … …  
    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.
    … …  
    507507
    508508    /**
    509      * @summary Collapses the admin menu.
     509     * Collapses the admin menu.
    510510     *
    511511     * @returns {void}
    … …  
    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
    … …  
    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
    … …  
    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.
    … …  
    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.
    … …  
    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}
    … …  
    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}
    … …  
    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.
    … …  
    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.
    … …  
    723723
    724724            /**
    725              * @summary Adjusts the size for the submenu.
     725             * Adjusts the size for the submenu.
    726726             *
    727727             * @returns {void}
    … …  
    744744
    745745    /**
    746      * @summary Make notices dismissible.
     746     * Makes notices dismissible.
    747747     *
    748748     * @since 4.4.0
    … …  
    777777
    778778    /**
    779      * @summary Checks a checkbox.
     779     * Checks a checkbox.
    780780     *
    781781     * This event needs to be delegated. Ticket #37973.
    … …  
    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.
    … …  
    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.
    … …  
    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.
    … …  
    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.
    … …  
    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}
    … …  
    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.
    … …  
    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.
    … …  
    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}
    … …  
    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.
    … …  
    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}
    … …  
    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
    … …  
    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.
    … …  
    11881188
    11891189    /**
    1190      * @summary Determines the height of certain elements.
     1190     * Determines the height of certain elements.
    11911191     *
    11921192     * @since 4.1.0
    … …  
    12041204
    12051205    /**
    1206      * @summary Unpins the menu.
     1206     * Unpins the menu.
    12071207     *
    12081208     * @since 4.1.0
    … …  
    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
    … …  
    12531253
    12541254    /**
    1255      * @summary Changes properties of metaboxes and body.
    1256      *
    12571255     * Changes the sortables and responsiveness of metaboxes.
    12581256     *
    … …  
    12641262
    12651263        /**
    1266          * @summary Initializes the wpResponsive object.
     1264         * Initializes the wpResponsive object.
    12671265         *
    12681266         * @since 3.8.0
    … …  
    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.
    … …  
    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.
    … …  
    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
    … …  
    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
    … …  
    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
    … …  
    14281426
    14291427        /**
    1430          * @summary Disables sortables.
     1428         * Disables sortables.
    14311429         *
    14321430         * @since 3.8.0
    … …  
    14431441
    14441442        /**
    1445          * @summary Enables sortables.
     1443         * Enables sortables.
    14461444         *
    14471445         * @since 3.8.0
    … …  
    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
    … …  
    14741472
    14751473    /**
    1476      * @summary Get the viewport width.
     1474     * Get the viewport width.
    14771475     *
    14781476     * @since 4.7.0
    … …  
    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
    … …  
    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
    … …  
    15831581
    15841582    /**
    1585      * @summary Triggers the WP window-resize event.
     1583     * Triggers the WP window-resize event.
    15861584     *
    15871585     * @since 3.8.0
    … …  
    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

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

    r40914 r42411  
    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
    … …  
    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
    … …  
    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
    … …  
    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
    … …  
    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
    … …  
    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
    … …  
    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
    … …  
    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

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

    r42385 r42411  
    22
    33/**
    4  * @summary Initializes the custom header selection page.
     4 * Initializes the custom header selection page.
    55 *
    66 * @since 3.5.0
    … …  
    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
    … …  
    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

  • trunk/src/wp-admin/js/editor-expand.js

    r41310 r42411  
    88
    99    /**
    10      * @summary Handles the resizing of the editor.
     10     * Handles the resizing of the editor.
    1111     *
    1212     * @since 4.0.0
    … …  
    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         *
     65         * Doesn't shrink the editor size below the 300px auto resize minimum height.
    6766         *
    6867         * @since 4.6.1
    … …  
    9190
    9291        /**
    93          * @summary Resizes the text editor depending on the old text length.
     92         * Resizes the text editor depending on the old text length.
    9493         *
    9594         * If there is an mceEditor and it is hidden, it resizes the editor depending
    … …  
    124123
    125124        /**
    126          * @summary Gets the height and widths of elements.
     125         * Gets the height and widths of elements.
    127126         *
    128127         * Gets the heights of the window, the adminbar, the tools, the menu,
    … …  
    159158        // We need to wait for TinyMCE to initialize.
    160159        /**
    161          * @summary Binds all necessary functions for editor expand to the editor
    162          * when the editor is initialized.
     160         * Binds all necessary functions for editor expand to the editor when the editor
     161         * is initialized.
    163162         *
    164163         * @since 4.0.0
    … …  
    173172            var VK = window.tinymce.util.VK,
    174173                /**
    175                  * @summary Hides any float panel with a hover state. Additionally hides tooltips.
     174                 * Hides any float panel with a hover state. Additionally hides tooltips.
    176175                 *
    177176                 * @returns {void}
    … …  
    200199
    201200            /**
    202              * @summary Gets the offset of the editor.
     201             * Gets the offset of the editor.
    203202             *
    204203             * @returns {Number|Boolean} Returns the offset of the editor
    … …  
    233232
    234233            /**
    235              * @summary Filters the special keys that should not be used for scrolling.
     234             * Filters the special keys that should not be used for scrolling.
    236235             *
    237236             * @since 4.0.0
    … …  
    256255
    257256            /**
    258              * @summary Makes sure the cursor is always visible in the editor.
     257             * Makes sure the cursor is always visible in the editor.
    259258             *
    260259             * Makes sure the cursor is kept between the toolbars of the editor and scrolls
    … …  
    323322
    324323            /**
    325              * @summary If the editor is fullscreen, calls adjust.
     324             * If the editor is fullscreen, calls adjust.
    326325             *
    327326             * @since 4.1.0
    … …  
    339338
    340339            /**
    341              * @summary Shows the editor when scrolled.
     340             * Shows the editor when scrolled.
    342341             *
    343342             * Binds the hideFloatPanels function on the window scroll.mce-float-panels event.
    … …  
    358357
    359358            /**
    360              * @summary Resizes the editor.
     359             * Resizes the editor.
    361360             *
    362361             * Removes all functions from the window scroll.mce-float-panels event.
    … …  
    385384
    386385            /**
    387              * @summary Toggles advanced states.
     386             * Toggles advanced states.
    388387             *
    389388             * @since 4.1.0
    … …  
    396395
    397396            /**
    398              * @summary Binds events of the editor and window.
     397             * Binds events of the editor and window.
    399398             *
    400399             * @since 4.0.0
    … …  
    421420
    422421            /**
    423              * @summary Unbinds the events of the editor and window.
     422             * Unbinds the events of the editor and window.
    424423             *
    425424             * @since 4.0.0
    … …  
    448447
    449448        /**
    450          * @summary Adjusts the toolbars heights and positions.
    451          *
    452          * Adjusts the toolbar heights and positions based on the scroll position on the page,
    453          * the active editor mode and the heights of the editor, admin bar and side bar.
     449         * Adjusts the toolbars heights and positions.
     450         *
     451         * Adjusts the toolbars heights and positions based on the scroll position on
     452         * the page, the active editor mode and the heights of the editor, admin bar and
     453         * side bar.
    454454         *
    455455         * @since 4.0.0
    … …  
    765765
    766766        /**
    767          * @summary Resizes the editor and adjusts the toolbars.
     767         * Resizes the editor and adjusts the toolbars.
    768768         *
    769769         * @since 4.0.0
    … …  
    777777
    778778        /**
    779          * @summary Runs the passed function with 500ms intervals.
     779         * Runs the passed function with 500ms intervals.
    780780         *
    781781         * @since 4.0.0
    … …  
    792792
    793793        /**
    794          * @summary Runs adjust after 100ms.
     794         * Runs adjust after 100ms.
    795795         *
    796796         * @since 4.0.0
    … …  
    804804
    805805        /**
    806          * @summary Binds editor expand events on elements.
     806         * Binds editor expand events on elements.
    807807         *
    808808         * @since 4.0.0
    … …  
    874874
    875875        /**
    876          * @summary Unbinds editor expand events.
     876         * Unbinds editor expand events.
    877877         *
    878878         * @since 4.0.0
    … …  
    968968
    969969    /**
    970      * @summary Handles the distraction free writing of TinyMCE.
     970     * Handles the distraction free writing of TinyMCE.
    971971     *
    972972     * @since 4.1.0
    … …  
    10181018
    10191019        /**
    1020          * @summary Recalculates the bottom and right position of the editor in the DOM.
     1020         * Recalculates the bottom and right position of the editor in the DOM.
    10211021         *
    10221022         * @since 4.1.0
    … …  
    10311031
    10321032        /**
    1033          * @summary Activates the distraction free writing mode.
     1033         * Activates the distraction free writing mode.
    10341034         *
    10351035         * @since 4.1.0
    … …  
    10471047
    10481048        /**
    1049          * @summary Deactivates the distraction free writing mode.
     1049         * Deactivates the distraction free writing mode.
    10501050         *
    10511051         * @since 4.1.0
    … …  
    10651065
    10661066        /**
    1067          * @summary Returns _isActive.
     1067         * Returns _isActive.
    10681068         *
    10691069         * @since 4.1.0
    … …  
    10761076
    10771077        /**
    1078          * @summary Binds events on the editor for distraction free writing.
     1078         * Binds events on the editor for distraction free writing.
    10791079         *
    10801080         * @since 4.1.0
    … …  
    10991099
    11001100        /**
    1101          * @summary Unbinds events on the editor for distraction free writing.
     1101         * Unbinds events on the editor for distraction free writing.
    11021102         *
    11031103         * @since 4.1.0
    … …  
    11221122
    11231123        /**
    1124          * @summary Binds or unbinds the editor expand events.
     1124         * Binds or unbinds the editor expand events.
    11251125         *
    11261126         * @since 4.1.0
    … …  
    11371137
    11381138        /**
    1139          * @summary Returns the value of _isOn.
     1139         * Returns the value of _isOn.
    11401140         *
    11411141         * @since 4.1.0
    … …  
    11481148
    11491149        /**
    1150          * @summary Fades out all elements except for the editor.
     1150         * Fades out all elements except for the editor.
    11511151         *
    11521152         * The fading is done based on key presses and mouse movements.
    … …  
    12911291
    12921292        /**
    1293          * @summary Fades all elements back in.
     1293         * Fades all elements back in.
    12941294         *
    12951295         * @since 4.1.0
    … …  
    13391339
    13401340        /**
    1341          * @summary Fades in if the focused element based on it position.
     1341         * Fades in if the focused element based on it position.
    13421342         *
    13431343         * @since 4.1.0
    … …  
    13611361
    13621362        /**
    1363          * @summary Fades out the admin bar based on focus on the admin bar.
     1363         * Fades out the admin bar based on focus on the admin bar.
    13641364         *
    13651365         * @since 4.1.0
    … …  
    13821382
    13831383        /**
    1384          * @summary Fades in the admin bar.
     1384         * Fades in the admin bar.
    13851385         *
    13861386         * @since 4.1.0
    … …  
    13971397
    13981398        /**
    1399          * @summary Fades out the edit slug box.
     1399         * Fades out the edit slug box.
    14001400         *
    14011401         * @since 4.1.0
    … …  
    14141414
    14151415        /**
    1416          * @summary Fades in the edit slug box.
     1416         * Fades in the edit slug box.
    14171417         *
    14181418         * @since 4.1.0
    … …  
    14311431
    14321432        /**
    1433          * @summary Triggers the toggle on Alt + Shift + W.
     1433         * Triggers the toggle on Alt + Shift + W.
    14341434         *
    14351435         * Keycode 87 = w.
    … …  
    14521452
    14531453        /**
    1454          * @summary Adds the distraction free writing button when setting up TinyMCE.
     1454         * Adds the distraction free writing button when setting up TinyMCE.
    14551455         *
    14561456         * @since 4.1.0
    … …  
    14931493
    14941494        /**
    1495          * @summary Binds and unbinds events on the editor.
     1495         * Binds and unbinds events on the editor.
    14961496         *
    14971497         * @since 4.1.0
    … …  
    15501550
    15511551        /**
    1552          * @summary Binds events on quicktags init.
     1552         * Binds events on quicktags init.
    15531553         *
    15541554         * @since 4.1.0

  • trunk/src/wp-admin/js/editor.js

    r42403 r42411  
    55
    66    /**
    7      * @summary Utility functions for the editor.
     7     * Utility functions for the editor.
    88     *
    99     * @since 2.5.0
    … …  
    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
    … …  
    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
    … …  
    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
    … …  
    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
    … …  
    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
    … …  
    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.
    … …  
    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
    … …  
    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
    … …  
    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`.
    … …  
    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)
    … …  
    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>`.
    … …  
    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
    … …  
    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
    … …  
    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`.
    … …  
    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.
    … …  
    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.
    … …  
    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
    … …  
    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

  • trunk/src/wp-admin/js/image-edit.js

    r42404 r42411  
    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
    … …  
    4545
    4646    /**
    47      * @summary Converts a value to an integer.
     47     * Converts a value to an integer.
    4848     *
    4949     * @memberof imageEdit
    … …  
    6363
    6464    /**
    65      * @summary Adds the disabled attribute and class to a single form element
    66      *          or a field set.
     65     * Adds the disabled attribute and class to a single form element or a field set.
    6766     *
    6867     * @memberof imageEdit
    … …  
    9392
    9493    /**
    95      * @summary Initializes the image editor.
     94     * Initializes the image editor.
    9695     *
    9796     * @memberof imageEdit
    … …  
    136135
    137136    /**
    138      * @summary Toggles the wait/load icon in the editor.
     137     * Toggles the wait/load icon in the editor.
    139138     *
    140139     * @memberof imageEdit
    … …  
    157156
    158157    /**
    159      * @summary Shows or hides the image edit help box.
     158     * Shows or hides the image edit help box.
    160159     *
    161160     * @memberof imageEdit
    … …  
    176175
    177176    /**
    178      * @summary Gets the value from the image edit target.
     177     * Gets the value from the image edit target.
    179178     *
    180179     * The image edit target contains the image sizes where the (possible) changes
    … …  
    194193
    195194    /**
    196      * @summary Recalculates the height or width and keeps the original aspect ratio.
     195     * Recalculates the height or width and keeps the original aspect ratio.
    197196     *
    198197     * If the original image size is exceeded a red exclamation mark is shown.
    … …  
    232231
    233232    /**
    234      * @summary Gets the selected aspect ratio.
     233     * Gets the selected aspect ratio.
    235234     *
    236235     * @memberof imageEdit
    … …  
    258257
    259258    /**
    260      * @summary Removes the last action from the image edit history
     259     * Removes the last action from the image edit history.
    261260     * The history consist of (edit) actions performed on the image.
    262261     *
    … …  
    322321    },
    323322    /**
    324      * @summary Binds the necessary events to the image.
     323     * Binds the necessary events to the image.
    325324     *
    326325     * When the image source is reloaded the image will be reloaded.
    … …  
    397396    },
    398397    /**
    399      * @summary Performs an image edit action.
     398     * Performs an image edit action.
    400399     *
    401400     * @memberof imageEdit
    … …  
    464463
    465464    /**
    466      * @summary Stores the changes that are made to the image.
     465     * Stores the changes that are made to the image.
    467466     *
    468467     * @memberof imageEdit
    … …  
    529528
    530529    /**
    531      * @summary Creates the image edit window.
     530     * Creates the image edit window.
    532531     *
    533532     * @memberof imageEdit
    … …  
    586585
    587586    /**
    588      * @summary Initializes the cropping tool and sets a default cropping selection.
     587     * Initializes the cropping tool and sets a default cropping selection.
    589588     *
    590589     * @memberof imageEdit
    … …  
    612611
    613612    /**
    614      * @summary Initializes the cropping tool.
     613     * Initializes the cropping tool.
    615614     *
    616615     * @memberof imageEdit
    … …  
    638637
    639638            /**
    640              * @summary Sets the CSS styles and binds events for locking the aspect ratio.
     639             * Sets the CSS styles and binds events for locking the aspect ratio.
    641640             *
    642641             * @ignore
    … …  
    651650                    .nextAll( '.imgareaselect-outer' ).css( 'position', 'absolute' );
    652651                /**
    653                  * @summary Binds mouse down event to the cropping container.
     652                 * Binds mouse down event to the cropping container.
    654653                 *
    655654                 * @returns {void}
    … …  
    671670
    672671            /**
    673              * @summary Event triggered when starting a selection.
     672             * Event triggered when starting a selection.
    674673             *
    675674             * @ignore
    … …  
    681680            },
    682681            /**
    683              * @summary Event triggered when the selection is ended.
     682             * Event triggered when the selection is ended.
    684683             *
    685684             * @ignore
    … …  
    695694
    696695            /**
    697              * @summary Event triggered when the selection changes.
     696             * Event triggered when the selection changes.
    698697             *
    699698             * @ignore
    … …  
    713712
    714713    /**
    715      * @summary Stores the current crop selection.
     714     * Stores the current crop selection.
    716715     *
    717716     * @memberof imageEdit
    … …  
    744743
    745744    /**
    746      * @summary Closes the image editor.
     745     * Closes the image editor.
    747746     *
    748747     * @memberof imageEdit
    … …  
    785784
    786785    /**
    787      * @summary Checks if the image edit history is saved.
     786     * Checks if the image edit history is saved.
    788787     *
    789788     * @memberof imageEdit
    … …  
    809808
    810809    /**
    811      * @summary Adds an image edit action to the history.
     810     * Adds an image edit action to the history.
    812811     *
    813812     * @memberof imageEdit
    … …  
    842841
    843842    /**
    844      * @summary Rotates the image.
     843     * Rotates the image.
    845844     *
    846845     * @memberof imageEdit
    … …  
    863862
    864863    /**
    865      * @summary Flips the image.
     864     * Flips the image.
    866865     *
    867866     * @memberof imageEdit
    … …  
    884883
    885884    /**
    886      * @summary Crops the image.
     885     * Crops the image.
    887886     *
    888887     * @memberof imageEdit
    … …  
    913912
    914913    /**
    915      * @summary Undoes an image edit action.
     914     * Undoes an image edit action.
    916915     *
    917916     * @memberof imageEdit
    … …  
    976975
    977976    /**
    978      * @summary Sets the selection for the height and width in pixels.
     977     * Sets the selection for the height and width in pixels.
    979978     *
    980979     * @memberof imageEdit

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

    r42403 r42411  
    2727
    2828    /**
    29      * @summary Initializes the inline and bulk post editor.
     29     * Initializes the inline and bulk post editor.
    3030     *
    3131     * Binds event handlers to the escape key to close the inline editor
    … …  
    4646
    4747        /**
    48          * @summary Bind escape key to revert the changes and close the quick editor.
     48         * Binds the escape key to revert the changes and close the quick editor.
    4949         *
    5050         * @returns {boolean} The result of revert.
    … …  
    5858
    5959        /**
    60          * @summary Bind escape key to revert the changes and close the bulk editor.
     60         * Binds the escape key to revert the changes and close the bulk editor.
    6161         *
    6262         * @returns {boolean} The result of revert.
    … …  
    7070
    7171        /**
    72          * @summary Revert changes and close the quick editor if the cancel button is clicked.
     72         * Reverts changes and close the quick editor if the cancel button is clicked.
    7373         *
    7474         * @returns {boolean} The result of revert.
    … …  
    7979
    8080        /**
    81          * @summary Save changes in the quick editor if the save(named: update) button is clicked.
     81         * Saves changes in the quick editor if the save(named: update) button is clicked.
    8282         *
    8383         * @returns {boolean} The result of save.
    … …  
    8888
    8989        /**
    90          * @summary If enter is pressed, and the target is not the cancel button, save the post.
     90         * If enter is pressed, and the target is not the cancel button, save the post.
    9191         *
    9292         * @returns {boolean} The result of save.
    … …  
    9999
    100100        /**
    101          * @summary Revert changes and close the bulk editor if the cancel button is clicked.
     101         * Reverts changes and close the bulk editor if the cancel button is clicked.
    102102         *
    103103         * @returns {boolean} The result of revert.
    … …  
    108108
    109109        /**
    110          * @summary Disables the password input field when the private post checkbox is checked.
     110         * Disables the password input field when the private post checkbox is checked.
    111111         */
    112112        $('#inline-edit .inline-edit-private input[value="private"]').click( function(){
    … …  
    120120
    121121        /**
    122          * @summary Bind click event to the .editinline link which opens the quick editor.
     122         * Binds click event to the .editinline link which opens the quick editor.
    123123         */
    124124        $('#the-list').on( 'click', 'a.editinline', function( e ) {
    … …  
    136136
    137137        /**
    138          * @summary Adds onclick events to the apply buttons.
     138         * Adds onclick events to the apply buttons.
    139139         */
    140140        $('#doaction, #doaction2').click(function(e){
    … …  
    154154
    155155    /**
    156      * @summary Toggles the quick edit window.
    157      *
    158      * Hides the window when it's active and shows the window when inactive.
     156     * Toggles the quick edit window, hiding it when it's active and showing it when
     157     * inactive.
    159158     *
    160159     * @memberof inlineEditPost
    … …  
    169168
    170169    /**
    171      * @summary Creates the bulk editor row to edit multiple posts at once.
     170     * Creates the bulk editor row to edit multiple posts at once.
    172171     *
    173172     * @memberof inlineEditPost
    … …  
    185184
    186185        /**
    187          * @summary Create a HTML div with the title and a delete link(cross-icon) for each selected post.
     186         * Create a HTML div with the title and a link(delete-icon) for each selected
     187         * post.
    188188         *
    189189         * Get the selected posts based on the checked checkboxes in the post table.
    190          * Create a HTML div with the title and a link(delete-icon) for each selected post.
    191190         */
    192191        $( 'tbody th.check-column input[type="checkbox"]' ).each( function() {
    … …  
    209208        $('#bulk-titles').html(te);
    210209        /**
    211          * @summary Binds on click events to the checkboxes before the posts in the table.
     210         * Binds on click events to the checkboxes before the posts in the table.
    212211         *
    213212         * @listens click
    … …  
    241240
    242241    /**
    243      * @summary Creates a quick edit window for the post that has been clicked.
     242     * Creates a quick edit window for the post that has been clicked.
    244243     *
    245244     * @memberof inlineEditPost
    … …  
    284283
    285284            /**
    286              * @summary Replaces the image for a Twemoji(Twitter emoji) with it's alternate text.
     285             * Replaces the image for a Twemoji(Twitter emoji) with it's alternate text.
    287286             *
    288287             * @returns Alternate text from the image.
    … …  
    304303
    305304        /**
    306          * @summary Creates the select boxes for the categories.
     305         * Creates the select boxes for the categories.
    307306         */
    308307        $('.post_category', rowData).each(function(){
    … …  
    317316
    318317        /**
    319          * @summary Gets all the taxonomies for live auto-fill suggestions.
    320          * When typing the name of a tag.
     318         * Gets all the taxonomies for live auto-fill suggestions when typing the name
     319         * of a tag.
    321320         */
    322321        $('.tags_input', rowData).each(function(){
    … …  
    381380
    382381    /**
    383      * @summary Saves the changes made in the quick edit window to the post.
     382     * Saves the changes made in the quick edit window to the post.
    384383     * AJAX saving is only for Quick Edit and not for bulk edit.
    385384     *
    … …  
    447446
    448447    /**
    449      * @summary Hides and empties the Quick Edit and/or Bulk Edit windows.
     448     * Hides and empties the Quick Edit and/or Bulk Edit windows.
    450449     *
    451450     * @memberof    inlineEditPost
    … …  
    488487
    489488    /**
    490      * @summary Gets the id for a the post that you want to quick edit from the row
    491      * in the quick edit table.
     489     * Gets the id for a the post that you want to quick edit from the row in the quick
     490     * edit table.
    492491     *
    493492     * @memberof    inlineEditPost

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

    r41684 r42411  
    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
     25     * quick edit.
    2726     *
    2827     * @since 2.7.0
    … …  
    4342        });
    4443
    45         /*
    46          * @summary Cancels inline editing when pressing escape inside the inline editor.
     44        /**
     45         * Cancels inline editing when pressing escape inside the inline editor.
    4746         *
    4847         * @param {Object} e The keyup event that has been triggered.
    … …  
    5655
    5756        /**
    58          * @summary Cancels inline editing when clicking the cancel button.
     57         * Cancels inline editing when clicking the cancel button.
    5958         */
    6059        $( '.cancel', row ).click( function() {
    … …  
    6362
    6463        /**
    65          * @summary Saves the inline edits when clicking the save button.
     64         * Saves the inline edits when clicking the save button.
    6665         */
    6766        $( '.save', row ).click( function() {
    … …  
    7069
    7170        /**
    72          * @summary Saves the inline edits when pressing enter inside the inline editor.
     71         * Saves the inline edits when pressing enter inside the inline editor.
    7372         */
    7473        $( 'input, select', row ).keydown( function( e ) {
    … …  
    8079
    8180        /**
    82          * @summary Saves the inline edits on submitting the inline edit form.
     81         * Saves the inline edits on submitting the inline edit form.
    8382         */
    8483        $( '#posts-filter input[type="submit"]' ).mousedown( function() {
    … …  
    150149
    151150    /**
    152      * @summary Saves the quick edit data.
     151     * Saves the quick edit data.
    153152     *
    154153     * Saves the quick edit data to the server and replaces the table row with the
    … …  
    188187        $.post( ajaxurl, params,
    189188            /**
    190              * @summary Handles the response from the server.
     189             * Handles the response from the server
    191190             *
    192191             * Handles the response from the server, replaces the table row with the response

  • trunk/src/wp-admin/js/media.js

    r42403 r42411  
    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
     5 * to it.
    56 *
    67 * @since 2.7.0
    … …  
    1516    findPosts = {
    1617        /**
    17          * @summary Opens a dialog to attach media to a post.
     18         * Opens a dialog to attach media to a post.
    1819         *
    1920         * Adds an overlay prior to retrieving a list of posts to attach the media to.
    … …  
    5960
    6061        /**
    61          * @summary Clears the found posts lists before hiding the attach media dialog.
     62         * Clears the found posts lists before hiding the attach media dialog.
    6263         *
    6364         * @since 2.7.0
    … …  
    7475
    7576        /**
    76          * @summary Binds a click event listener to the overlay which closes the attach media dialog.
     77         * Binds a click event listener to the overlay which closes the attach media
     78         * dialog.
    7779         *
    7880         * @since 3.5.0
    … …  
    8991
    9092        /**
    91          * @summary Retrieves and displays posts based on the search term.
    92          *
    93          * Sends a post request to the admin_ajax.php, requesting posts based on the search term provided by the user.
    94          * Defaults to all posts if no search term is provided.
     93         * Retrieves and displays posts based on the search term.
     94         *
     95         * Sends a post request to the admin_ajax.php, requesting posts based on the
     96         * search term provided by the user. Defaults to all posts if no search term is
     97         * provided.
    9598         *
    9699         * @since 2.7.0
    … …  
    111114
    112115            /**
    113              * Send a POST request to admin_ajax.php, hide the spinner and replace the list of posts with the response data.
    114              * If an error occurs, display it.
     116             * Send a POST request to admin_ajax.php, hide the spinner and replace the list
     117             * of posts with the response data. If an error occurs, display it.
    115118             */
    116119            $.ajax( ajaxurl, {
    … …  
    133136
    134137    /**
    135      * @summary Initializes the file once the DOM is fully loaded and attaches events to the various form elements.
     138     * Initializes the file once the DOM is fully loaded and attaches events to the
     139     * various form elements.
    136140     *
    137141     * @returns {void}
    … …  
    193197
    194198        /**
    195          * @summary Enables clicking on the entire table row.
     199         * Enables clicking on the entire table row.
    196200         *
    197201         * @returns {void}

  • trunk/src/wp-admin/js/post.js

    r42403 r42411  
    33
    44/**
    5  * Contains all dynamic functionality needed on post and term pages.
    6  *
    7  * @file Control page and term functionality.
     5 * @file Contains all dynamic functionality needed on post and term pages.
    86 */
    97
    … …  
    935933
    936934    /**
    937      * Handle the editing of the post_name. Create the required HTML elements and update the changes via AJAX.
    938      *
    939      * @summary Permalink aka slug aka post_name editing
     935     * Handle the editing of the post_name. Create the required HTML elements and
     936     * update the changes via AJAX.
    940937     *
    941938     * @global
    … …  
    10421039
    10431040    /**
    1044      * Add screen reader text to the title prompt when needed.
    1045      *
    1046      * @summary Title screen reader text handler.
     1041     * Adds screen reader text to the title prompt when needed.
    10471042     *
    10481043     * @param {string} id Optional. HTML ID to add the screen reader helper text to.

  • trunk/src/wp-admin/js/postbox.js

    r42403 r42411  
    22 * Contains the postboxes logic, opening and closing postboxes, reordering and saving
    33 * the state and ordering to the database.
    4  *
    5  * @summary Contains postboxes logic
    64 *
    75 * @since 2.5.0
    … …  
    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.
    … …  
    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.
    … …  
    118116
    119117            /**
    120              * @summary Hides a postbox.
     118             * Hides a postbox.
    121119             *
    122120             * Event handler for the postbox dismiss button. After clicking the button
    … …  
    134132
    135133            /**
    136              * @summary Hides the postbox element
     134             * Hides the postbox element
    137135             *
    138136             * Event handler for the screen options checkboxes. When a checkbox is
    … …  
    174172
    175173            /**
    176              * @summary Changes the amount of columns based on the layout preferences.
     174             * Changes the amount of columns based on the layout preferences.
    177175             *
    178176             * @since 2.8.0
    … …  
    191189
    192190        /**
    193          * @summary Initializes all the postboxes, mainly their sortable behaviour.
     191         * Initializes all the postboxes, mainly their sortable behaviour.
    194192         *
    195193         * @since 2.7.0
    … …  
    270268
    271269        /**
    272          * @summary Saves the state of the postboxes to the server.
    273          *
    274          * Saves the state of the postboxes to the server. It sends two lists, one with
    275          * all the closed postboxes, one with all the hidden postboxes.
     270         * Saves the state of the postboxes to the server.
     271         *
     272         * It sends two lists, one with all the closed postboxes, one with all the
     273         * hidden postboxes.
    276274         *
    277275         * @since 2.7.0
    … …  
    302300
    303301        /**
    304          * @summary Saves the order of the postboxes to the server.
    305          *
    306          * Saves the order of the postboxes to the server. Sends a list of all postboxes
    307          * inside a sortable area to the server.
     302         * Saves the order of the postboxes to the server.
     303         *
     304         * Sends a list of all postboxes inside a sortable area to the server.
    308305         *
    309306         * @since 2.8.0
    … …  
    331328
    332329        /**
    333          * @summary Marks empty postbox areas.
     330         * Marks empty postbox areas.
    334331         *
    335332         * Adds a message to empty sortable areas on the dashboard page. Also adds a
    … …  
    367364
    368365        /**
    369          * @summary Changes the amount of columns on the post edit page.
     366         * Changes the amount of columns on the post edit page.
    370367         *
    371368         * @since 3.3.0
    … …  
    396393
    397394        /**
    398          * @summary Changes the amount of columns the postboxes are in based on the
    399          *          current orientation of the browser.
     395         * Changes the amount of columns the postboxes are in based on the current
     396         * orientation of the browser.
    400397         *
    401398         * @since 3.3.0

  • trunk/src/wp-admin/js/tags.js

    r41311 r42411  
    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
    … …  
    1110
    1211    /**
    13      * @summary Adds an event handler to the delete term link on the term overview page.
     12     * Adds an event handler to the delete term link on the term overview page.
    1413     *
    15      * Adds an event handler to the delete term link on the term overview page.
    1614     * Cancels default event handling and event bubbling.
    1715     *
    … …  
    3028
    3129            /**
    32              * @summary Makes a request to the server to delete the term that
    33              * corresponds to the delete term button.
     30             * Makes a request to the server to delete the term that corresponds to the
     31             * delete term button.
    3432             *
    3533             * @param {string} r The response from the server.
    … …  
    4341
    4442                    /**
    45                      * @summary Remove the term from the parent box and the tag cloud
     43                     * Removes the term from the parent box and the tag cloud.
    4644                     *
    4745                     * `data.match(/tag_ID=(\d+)/)[1]` matches the term id from the data variable.
    … …  
    8886
    8987    /**
    90      * @summary Adds an event handler tot he form submit on the term overview page.
     88     * Adds an event handler to the form submit on the term overview page.
    9189     *
    9290     * Cancels default event handling and event bubbling.

  • trunk/src/wp-admin/js/word-count.js

    r39739 r42411  
    11/**
    2  * Word or character counting functionality. Count words or characters in a provided text string.
    3  *
    4  * @summary   Count words or characters in a text.
     2 * Word or character counting functionality. Count words or characters in a
     3 * provided text string.
    54 *
    65 * @namespace wp.utils
    … …  
    144143     * Counts the number of words (or other specified type) in the specified text.
    145144     *
    146      * @summary  Count the number of elements in a text.
    147      *
    148145     * @since    2.6.0
    149146     * @memberof wp.utils.wordcounter

  • trunk/src/wp-content/themes/twentyfifteen/js/functions.js

    r36999 r42411  
    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.

  • trunk/src/wp-content/themes/twentyfourteen/js/functions.js

    r39226 r42411  
    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.

  • trunk/src/wp-content/themes/twentythirteen/js/functions.js

    r38083 r42411  
    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     */

  • trunk/src/wp-includes/js/autosave.js

    r41351 r42411  
    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
    … …  
    1616( function( $, window ) {
    1717    /**
    18      * @summary Auto saves the post.
     18     * Auto saves the post.
    1919     *
    2020     * @since 3.9.0
    … …  
    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
    … …  
    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
     103         * when auto-saving.
    105104         *
    106105         * @since 3.9.0
    … …  
    119118
    120119        /**
    121          * @summary Disables save buttons.
     120         * Disables save buttons.
    122121         *
    123122         * @since 3.9.0
    … …  
    133132
    134133        /**
    135          * @summary Enables save buttons.
     134         * Enables save buttons.
    136135         *
    137136         * @since 3.9.0
    … …  
    144143
    145144        /**
    146          * @summary Gets the content editor.
     145         * Gets the content editor.
    147146         *
    148147         * @since 4.6.0
    … …  
    156155
    157156        /**
    158          * @summary Autosave in localStorage.
     157         * Autosave in localStorage.
    159158         *
    160159         * @since 3.9.0
    … …  
    177176
    178177            /**
    179              * @summary Checks if the browser supports sessionStorage and it's not disabled.
     178             * Checks if the browser supports sessionStorage and it's not disabled.
    180179             *
    181180             * @since 3.9.0
    … …  
    198197
    199198            /**
    200              * @summary Initializes the local storage.
     199             * Initializes the local storage.
    201200             *
    202201             * @since 3.9.0
    … …  
    222221
    223222            /**
    224              * @summary Sets the storage for this blog.
    225              *
    226              * Confirms that the data was saved successfully.
     223             * Sets the storage for this blog. Confirms that the data was saved
     224             * successfully.
    227225             *
    228226             * @since 3.9.0
    … …  
    243241
    244242            /**
    245              * @summary Gets the saved post data for the current post.
     243             * Gets the saved post data for the current post.
    246244             *
    247245             * @since 3.9.0
    … …  
    260258
    261259            /**
    262              * @summary Sets (save or delete) post data in the storage.
     260             * Sets (save or delete) post data in the storage.
    263261             *
    264262             * If stored_data evaluates to 'false' the storage key for the current post will be removed.
    … …  
    289287
    290288            /**
    291              * @summary Sets isSuspended to true.
     289             * Sets isSuspended to true.
    292290             *
    293291             * @since 3.9.0
    … …  
    300298
    301299            /**
    302              * @summary Sets isSuspended to false.
     300             * Sets isSuspended to false.
    303301             *
    304302             * @since 3.9.0
    … …  
    311309
    312310            /**
    313              * @summary Saves post data for the current post.
     311             * Saves post data for the current post.
    314312             *
    315313             * Runs on a 15 sec. interval, saves when there are differences in the post title or content.
    … …  
    360358
    361359            /**
    362              * @summary Initializes the auto save function.
     360             * Initializes the auto save function.
    363361             *
    364362             * Checks whether the editor is active or not to use the editor events
    … …  
    420418
    421419            /**
    422              * @summary Compares 2 strings.
    423              *
    424              * Removes whitespaces in the strings before comparing them.
     420             * Compares 2 strings. Removes whitespaces in the strings before comparing them.
    425421             *
    426422             * @since 3.9.0
    … …  
    439435
    440436            /**
    441              * @summary Checks if the saved data for the current post (if any) is different
    442              * than the loaded post data on the screen.
     437             * Checks if the saved data for the current post (if any) is different than the
     438             * loaded post data on the screen.
    443439             *
    444440             * Shows a standard message letting the user restore the post data if different.
    … …  
    508504
    509505            /**
    510              * @summary Restores the current title, content and excerpt from postData.
     506             * Restores the current title, content and excerpt from postData.
    511507             *
    512508             * @since 3.9.0
    … …  
    576572
    577573        /**
    578          * @summary Auto saves the post on the server.
     574         * Auto saves the post on the server.
    579575         *
    580576         * @since 3.9.0
    … …  
    597593
    598594            /**
    599              * @summary  Blocks saving for the next 10 seconds.
     595             * Blocks saving for the next 10 seconds.
    600596             *
    601597             * @since 3.9.0
    … …  
    613609
    614610            /**
    615              * @summary Sets isSuspended to true.
     611             * Sets isSuspended to true.
    616612             *
    617613             * @since 3.9.0
    … …  
    624620
    625621            /**
    626              * @summary Sets isSuspended to false.
     622             * Sets isSuspended to false.
    627623             *
    628624             * @since 3.9.0
    … …  
    635631
    636632            /**
    637              * @summary Triggers the autosave with the post data.
     633             * Triggers the autosave with the post data.
    638634             *
    639635             * @since 3.9.0
    … …  
    659655
    660656            /**
    661              * @summary Saves immediately.
     657             * Saves immediately.
    662658             *
    663659             * Resets the timing and tells heartbeat to connect now.
    … …  
    673669
    674670            /**
    675              * @summary Checks if the post content in the textarea has changed since page load.
     671             * Checks if the post content in the textarea has changed since page load.
    676672             *
    677673             * This also happens when TinyMCE is active and editor.save() is triggered by
    … …  
    687683
    688684            /**
    689              * @summary Checks if the post can be saved or not.
     685             * Checks if the post can be saved or not.
    690686             *
    691687             * If the post hasn't changed or it cannot be updated,
    … …  
    734730
    735731            /**
    736              * @summary Sets the next run, based on the autosave interval.
     732             * Sets the next run, based on the autosave interval.
    737733             *
    738734             * @private
    … …  
    747743
    748744            /**
    749              * @summary Sets the autosaveData on the autosave heartbeat.
     745             * Sets the autosaveData on the autosave heartbeat.
    750746             *
    751747             * @since 3.9.0
    … …  
    761757
    762758                /**
    763                  * @summary Triggers the autosave of the post with the autosave data
    764                  * on the autosave heartbeat.
     759                 * Triggers the autosave of the post with the autosave data on the autosave
     760                 * heartbeat.
    765761                 *
    766762                 * @since 3.9.0
    … …  
    773769                }
    774770                /**
    775                  * @summary Disables buttons and throws a notice when the connection is lost.
     771                 * Disables buttons and throws a notice when the connection is lost.
    776772                 *
    777773                 * @since 3.9.0
    … …  
    794790
    795791                /**
    796                  * @summary Enables buttons when the connection is restored.
     792                 * Enables buttons when the connection is restored.
    797793                 *
    798794                 * @since 3.9.0
    … …  
    817813
    818814        /**
    819          * @summary Sets the autosave time out.
     815         * Sets the autosave time out.
    820816         *
    821817         * Wait for TinyMCE to initialize plus 1 second. for any external css to finish loading,

  • trunk/src/wp-includes/js/comment-reply.js

    r42403 r42411  
    11/**
    2  * @summary Handles the addition of the comment form.
     2 * Handles the addition of the comment form.
    33 *
    44 * @since 2.7.0

  • trunk/src/wp-includes/js/media-audiovideo.js

    r41781 r42411  
    7474/**
    7575 *
    76  * @summary Defines the wp.media.mixin object.
     76 * Defines the wp.media.mixin object.
    7777 *
    7878 * @mixin
    … …  
    8484
    8585    /**
    86      * @summary Pauses and removes all players.
     86     * Pauses and removes all players.
    8787     *
    8888     * @since 4.2.0
    … …  
    102102
    103103    /**
    104      * @summary Removes the player.
     104     * Removes the player.
    105105     *
    106106     * Override the MediaElement method for removing a player.
    … …  
    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
    … …  
    169169
    170170/**
    171  * @summary Shortcode modeling for playlists.
     171 * Shortcode modeling for playlists.
    172172 *
    173173 * @since 4.2.0
    … …  
    188188
    189189/**
    190  * @summary Shortcode modeling for audio.
     190 * Shortcode modeling for audio.
    191191 *
    192192 * `edit()` prepares the shortcode for the media modal.
    … …  
    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
    … …  
    230230
    231231    /**
    232      * @summary Generates an audio shortcode.
     232     * Generates an audio shortcode.
    233233     *
    234234     * @since 4.2.0
    … …  
    260260
    261261/**
    262  * @summary Shortcode modeling for video.
     262 * Shortcode modeling for video.
    263263 *
    264264 *  `edit()` prepares the shortcode for the media modal.
    … …  
    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
    … …  
    310310
    311311    /**
    312      * @summary Generates an video shortcode.
     312     * Generates an video shortcode.
    313313     *
    314314     * @since 4.2.0

  • trunk/src/wp-includes/js/media-views.js

    r42410 r42411  
    23372337
    23382338    /**
    2339      * @summary Opens the crop image window.
    2340      *
    23412339     * Shows the crop image window when called from the Add new image button.
    23422340     *
    … …  
    23522350
    23532351    /**
    2354      * @summary Changes the state of the toolbar window to browse mode.
     2352     * Changes the state of the toolbar window to browse mode.
    23552353     *
    23562354     * @since 4.2.0
    … …  
    23632361
    23642362    /**
    2365      * @summary Creates the crop image window.
     2363     * Creates the crop image window.
    23662364     *
    23672365     * Initialized when clicking on the Select and Crop button.
    … …  
    23842382
    23852383    /**
    2386      * @summary Removes the image selection and closes the cropping window.
     2384     * Removes the image selection and closes the cropping window.
    23872385     *
    23882386     * @since 4.2.0
    … …  
    23982396
    23992397    /**
    2400      * @summary Checks if cropping can be skipped and creates crop toolbar accordingly.
     2398     * Checks if cropping can be skipped and creates crop toolbar accordingly.
    24012399     *
    24022400     * @since 4.2.0
    … …  
    24602458
    24612459    /**
    2462      * @summary Creates an object with the image attachment and crop properties.
     2460     * Creates an object with the image attachment and crop properties.
    24632461     *
    24642462     * @since 4.2.0

  • trunk/src/wp-includes/js/media/audiovideo.manifest.js

    r41781 r42411  
    55/**
    66 *
    7  * @summary Defines the wp.media.mixin object.
     7 * Defines the wp.media.mixin object.
    88 *
    99 * @mixin
    … …  
    1515
    1616    /**
    17      * @summary Pauses and removes all players.
     17     * Pauses and removes all players.
    1818     *
    1919     * @since 4.2.0
    … …  
    3333
    3434    /**
    35      * @summary Removes the player.
     35     * Removes the player.
    3636     *
    3737     * Override the MediaElement method for removing a player.
    … …  
    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
    … …  
    100100
    101101/**
    102  * @summary Shortcode modeling for playlists.
     102 * Shortcode modeling for playlists.
    103103 *
    104104 * @since 4.2.0
    … …  
    119119
    120120/**
    121  * @summary Shortcode modeling for audio.
     121 * Shortcode modeling for audio.
    122122 *
    123123 * `edit()` prepares the shortcode for the media modal.
    … …  
    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
    … …  
    161161
    162162    /**
    163      * @summary Generates an audio shortcode.
     163     * Generates an audio shortcode.
    164164     *
    165165     * @since 4.2.0
    … …  
    191191
    192192/**
    193  * @summary Shortcode modeling for video.
     193 * Shortcode modeling for video.
    194194 *
    195195 *  `edit()` prepares the shortcode for the media modal.
    … …  
    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
    … …  
    241241
    242242    /**
    243      * @summary Generates an video shortcode.
     243     * Generates an video shortcode.
    244244     *
    245245     * @since 4.2.0

  • trunk/src/wp-includes/js/media/controllers/cropper.js

    r42352 r42411  
    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     *
    … …  
    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
    … …  
    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.
    … …  
    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
    … …  
    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
    … …  
    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
Note: See TracChangeset for help on using the changeset viewer.