WordPress.org

Make WordPress Core

Changeset 46799


Ignore:
Timestamp:
11/29/2019 04:55:01 PM (19 months ago)
Author:
SergeyBiryukov
Message:

Docs: Add missing full stops to @returns tags in JS docs, per the documentation standards.

Props shital-patel, kalpshit.
Fixes #48305.

Location:
trunk/src/js
Files:
27 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/js/_enqueues/lib/color-picker.js

    r43347 r46799  
    328328         * @since 3.5.0
    329329         *
    330          * @returns {string} The element's color
     330         * @returns {string} The element's color.
    331331         */
    332332        color: function( newColor ) {
  • trunk/src/js/_enqueues/wp/customize/controls.js

    r46739 r46799  
    11551155         * @param {Boolean} active
    11561156         * @param {Object}  [params]
    1157          * @returns {Boolean} false if state already applied
     1157         * @returns {Boolean} False if state already applied.
    11581158         */
    11591159        _toggleActive: function ( active, params ) {
     
    11741174        /**
    11751175         * @param {Object} [params]
    1176          * @returns {Boolean} false if already active
     1176         * @returns {Boolean} False if already active.
    11771177         */
    11781178        activate: function ( params ) {
     
    11821182        /**
    11831183         * @param {Object} [params]
    1184          * @returns {Boolean} false if already inactive
     1184         * @returns {Boolean} False if already inactive.
    11851185         */
    11861186        deactivate: function ( params ) {
     
    12021202         * @param {Object}   [params] - Object containing options for expand/collapse.
    12031203         * @param {Function} [params.completeCallback] - Function to call when expansion/collapse is complete.
    1204          * @returns {Boolean} false if state already applied or active state is false
     1204         * @returns {Boolean} False if state already applied or active state is false.
    12051205         */
    12061206        _toggleExpanded: function( expanded, params ) {
     
    12391239        /**
    12401240         * @param {Object} [params]
    1241          * @returns {Boolean} false if already expanded or if inactive.
     1241         * @returns {Boolean} False if already expanded or if inactive.
    12421242         */
    12431243        expand: function ( params ) {
     
    12471247        /**
    12481248         * @param {Object} [params]
    1249          * @returns {Boolean} false if already collapsed.
     1249         * @returns {Boolean} False if already collapsed.
    12501250         */
    12511251        collapse: function ( params ) {
  • trunk/src/js/_enqueues/wp/customize/nav-menus.js

    r46637 r46799  
    19631963         * @param {Boolean} expanded
    19641964         * @param {Object} [params]
    1965          * @returns {Boolean} false if state already applied
     1965         * @returns {Boolean} False if state already applied.
    19661966         */
    19671967        _toggleExpanded: api.Section.prototype._toggleExpanded,
     
    19711971         *
    19721972         * @param {Object} [params]
    1973          * @returns {Boolean} false if already expanded
     1973         * @returns {Boolean} False if already expanded.
    19741974         */
    19751975        expand: api.Section.prototype.expand,
     
    19911991         *
    19921992         * @param {Object} [params]
    1993          * @returns {Boolean} false if already collapsed
     1993         * @returns {Boolean} False if already collapsed.
    19941994         */
    19951995        collapse: api.Section.prototype.collapse,
  • trunk/src/js/_enqueues/wp/customize/widgets.js

    r45658 r46799  
    13411341         * @param {Boolean} expanded
    13421342         * @param {Object} [params]
    1343          * @returns {Boolean} false if state already applied
     1343         * @returns {Boolean} False if state already applied.
    13441344         */
    13451345        _toggleExpanded: api.Section.prototype._toggleExpanded,
     
    13491349         *
    13501350         * @param {Object} [params]
    1351          * @returns {Boolean} false if already expanded
     1351         * @returns {Boolean} False if already expanded.
    13521352         */
    13531353        expand: api.Section.prototype.expand,
     
    13661366         *
    13671367         * @param {Object} [params]
    1368          * @returns {Boolean} false if already collapsed
     1368         * @returns {Boolean} False if already collapsed.
    13691369         */
    13701370        collapse: api.Section.prototype.collapse,
     
    20612061
    20622062        /**
    2063          * @param {string} widgetId or an id_base for adding a previously non-existing widget
    2064          * @returns {object|false} widget_form control instance, or false on error
     2063         * @param {string} widgetId or an id_base for adding a previously non-existing widget.
     2064         * @returns {object|false} widget_form control instance, or false on error.
    20652065         */
    20662066        addWidget: function( widgetId ) {
  • trunk/src/js/_enqueues/wp/editor/base.js

    r44649 r46799  
    659659         * and why this solution was chosen.
    660660         *
    661          * @param {Object} editor The editor where we must find the selection
    662          * @returns {(null|Object)} The selection range position in the editor
     661         * @param {Object} editor The editor where we must find the selection.
     662         * @returns {(null|Object)} The selection range position in the editor.
    663663         */
    664664        function findBookmarkedPosition( editor ) {
  • trunk/src/js/_enqueues/wp/media/editor.js

    r43582 r46799  
    2222     * @param {object} attrs Map of props from a shortcode or settings.
    2323     * @param {string} key The key within the passed map to check for a value.
    24      * @returns {mixed|undefined} The original or coerced value of key within attrs
     24     * @returns {mixed|undefined} The original or coerced value of key within attrs.
    2525     */
    2626    wp.media.coerce = function ( attrs, key ) {
  • trunk/src/js/media/controllers/region.js

    r43309 r46799  
    7878     * @fires Region#render
    7979     *
    80      * @returns {wp.media.controller.Region} Returns itself to allow chaining
     80     * @returns {wp.media.controller.Region} Returns itself to allow chaining.
    8181     */
    8282    render: function( mode ) {
     
    134134     * @param {Array|Object} views
    135135     * @param {Object} [options={}]
    136      * @returns {wp.Backbone.Subviews} Subviews is returned to allow chaining
     136     * @returns {wp.Backbone.Subviews} Subviews is returned to allow chaining.
    137137     */
    138138    set: function( views, options ) {
  • trunk/src/js/media/controllers/state-machine.js

    r46157 r46799  
    6666     * @fires wp.media.controller.State#activate
    6767     *
    68      * @returns {wp.media.controller.StateMachine} Returns itself to allow chaining
     68     * @returns {wp.media.controller.StateMachine} Returns itself to allow chaining.
    6969     */
    7070    setState: function( id ) {
  • trunk/src/js/media/models/attachments.js

    r46239 r46799  
    173173     * @param {wp.media.model.Attachment} attachment
    174174     * @param {Object} options
    175      * @returns {wp.media.model.Attachments} Returns itself to allow chaining
     175     * @returns {wp.media.model.Attachments} Returns itself to allow chaining.
    176176     */
    177177    validate: function( attachment, options ) {
     
    196196     * @fires wp.media.model.Attachments#reset
    197197     *
    198      * @returns {wp.media.model.Attachments} Returns itself to allow chaining
     198     * @returns {wp.media.model.Attachments} Returns itself to allow chaining.
    199199     */
    200200    validateAll: function( attachments, options ) {
     
    230230     *
    231231     * @param {wp.media.model.Attachments} The attachments collection to stop observing.
    232      * @returns {wp.media.model.Attachments} Returns itself to allow chaining
     232     * @returns {wp.media.model.Attachments} Returns itself to allow chaining.
    233233     */
    234234    unobserve: function( attachments ) {
     
    253253     * @param {Object} options
    254254     *
    255      * @returns {wp.media.model.Attachments} Returns itself to allow chaining
     255     * @returns {wp.media.model.Attachments} Returns itself to allow chaining.
    256256     */
    257257    _validateHandler: function( attachment, attachments, options ) {
     
    269269     * @param {wp.media.model.Attachments} attachments
    270270     * @param {Object} options
    271      * @returns {wp.media.model.Attachments} Returns itself to allow chaining
     271     * @returns {wp.media.model.Attachments} Returns itself to allow chaining.
    272272     */
    273273    _validateAllHandler: function( attachments, options ) {
     
    279279     *
    280280     * @param {wp.media.model.Attachments} The attachments collection to mirror.
    281      * @returns {wp.media.model.Attachments} Returns itself to allow chaining
     281     * @returns {wp.media.model.Attachments} Returns itself to allow chaining.
    282282     */
    283283    mirror: function( attachments ) {
  • trunk/src/js/media/views/attachment-compat.js

    r43309 r46799  
    2929    },
    3030    /**
    31      * @returns {wp.media.view.AttachmentCompat} Returns itself to allow chaining
     31     * @returns {wp.media.view.AttachmentCompat} Returns itself to allow chaining.
    3232     */
    3333    dispose: function() {
     
    4141    },
    4242    /**
    43      * @returns {wp.media.view.AttachmentCompat} Returns itself to allow chaining
     43     * @returns {wp.media.view.AttachmentCompat} Returns itself to allow chaining.
    4444     */
    4545    render: function() {
  • trunk/src/js/media/views/attachment.js

    r46157 r46799  
    7070    },
    7171    /**
    72      * @returns {wp.media.view.Attachment} Returns itself to allow chaining
     72     * @returns {wp.media.view.Attachment} Returns itself to allow chaining.
    7373     */
    7474    dispose: function() {
     
    8888    },
    8989    /**
    90      * @returns {wp.media.view.Attachment} Returns itself to allow chaining
     90     * @returns {wp.media.view.Attachment} Returns itself to allow chaining.
    9191     */
    9292    render: function() {
     
    435435    /**
    436436     * @param {string} status
    437      * @returns {wp.media.view.Attachment} Returns itself to allow chaining
     437     * @returns {wp.media.view.Attachment} Returns itself to allow chaining.
    438438     */
    439439    updateSave: function( status ) {
     
    530530     * @param {Backbone.Model} model
    531531     * @param {string} value
    532      * @returns {wp.media.view.Attachment} Returns itself to allow chaining
     532     * @returns {wp.media.view.Attachment} Returns itself to allow chaining.
    533533     */
    534534    /**
     
    539539     * @param {Backbone.Model} model
    540540     * @param {string} value
    541      * @returns {wp.media.view.Attachment} Returns itself to allow chaining
     541     * @returns {wp.media.view.Attachment} Returns itself to allow chaining.
    542542     */
    543543    /**
     
    548548     * @param {Backbone.Model} model
    549549     * @param {string} value
    550      * @returns {wp.media.view.Attachment} Returns itself to allow chaining
     550     * @returns {wp.media.view.Attachment} Returns itself to allow chaining.
    551551     */
    552552    /**
     
    557557     * @param {Backbone.Model} model
    558558     * @param {string} value
    559      * @returns {wp.media.view.Attachment} Returns itself to allow chaining
     559     * @returns {wp.media.view.Attachment} Returns itself to allow chaining.
    560560     */
    561561    Attachment.prototype[ method ] = function( model, value ) {
  • trunk/src/js/media/views/attachments/browser.js

    r46549 r46799  
    124124
    125125    /**
    126      * @returns {wp.media.view.AttachmentsBrowser} Returns itself to allow chaining
     126     * @returns {wp.media.view.AttachmentsBrowser} Returns itself to allow chaining.
    127127     */
    128128    dispose: function() {
  • trunk/src/js/media/views/button.js

    r43309 r46799  
    4848    },
    4949    /**
    50      * @returns {wp.media.view.Button} Returns itself to allow chaining
     50     * @returns {wp.media.view.Button} Returns itself to allow chaining.
    5151     */
    5252    render: function() {
  • trunk/src/js/media/views/embed/url.js

    r45524 r46799  
    4040    },
    4141    /**
    42      * @returns {wp.media.view.EmbedUrl} Returns itself to allow chaining
     42     * @returns {wp.media.view.EmbedUrl} Returns itself to allow chaining.
    4343     */
    4444    render: function() {
  • trunk/src/js/media/views/frame.js

    r43309 r46799  
    8181     * Reset all states on the frame to their defaults.
    8282     *
    83      * @returns {wp.media.view.Frame} Returns itself to allow chaining
     83     * @returns {wp.media.view.Frame} Returns itself to allow chaining.
    8484     */
    8585    reset: function() {
  • trunk/src/js/media/views/iframe.js

    r43309 r46799  
    1212    className: 'media-iframe',
    1313    /**
    14      * @returns {wp.media.view.Iframe} Returns itself to allow chaining
     14     * @returns {wp.media.view.Iframe} Returns itself to allow chaining.
    1515     */
    1616    render: function() {
  • trunk/src/js/media/views/media-details.js

    r46157 r46799  
    124124
    125125    /**
    126      * @returns {media.view.MediaDetails} Returns itself to allow chaining
     126     * @returns {media.view.MediaDetails} Returns itself to allow chaining.
    127127     */
    128128    render: function() {
  • trunk/src/js/media/views/media-frame.js

    r46438 r46799  
    144144
    145145    /**
    146      * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining
     146     * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining.
    147147     */
    148148    render: function() {
     
    317317     * @instance
    318318     *
    319      * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining
     319     * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining.
    320320     */
    321321    /**
     
    324324     * @instance
    325325     *
    326      * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining
     326     * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining.
    327327     */
    328328    /**
     
    331331     * @instance
    332332     *
    333      * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining
     333     * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining.
    334334     */
    335335    /**
     
    338338     * @instance
    339339     *
    340      * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining
     340     * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining.
    341341     */
    342342    /**
     
    345345     * @instance
    346346     *
    347      * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining
     347     * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining.
    348348     */
    349349    MediaFrame.prototype[ method ] = function() {
  • trunk/src/js/media/views/menu-item.js

    r46363 r46799  
    4848
    4949    /**
    50      * @returns {wp.media.view.MenuItem} returns itself to allow chaining
     50     * @returns {wp.media.view.MenuItem} returns itself to allow chaining.
    5151     */
    5252    render: function() {
  • trunk/src/js/media/views/modal.js

    r45572 r46799  
    4848
    4949    /**
    50      * @returns {wp.media.view.Modal} Returns itself to allow chaining
     50     * @returns {wp.media.view.Modal} Returns itself to allow chaining.
    5151     */
    5252    attach: function() {
     
    6969
    7070    /**
    71      * @returns {wp.media.view.Modal} Returns itself to allow chaining
     71     * @returns {wp.media.view.Modal} Returns itself to allow chaining.
    7272     */
    7373    detach: function() {
     
    8282
    8383    /**
    84      * @returns {wp.media.view.Modal} Returns itself to allow chaining
     84     * @returns {wp.media.view.Modal} Returns itself to allow chaining.
    8585     */
    8686    open: function() {
     
    126126    /**
    127127     * @param {Object} options
    128      * @returns {wp.media.view.Modal} Returns itself to allow chaining
     128     * @returns {wp.media.view.Modal} Returns itself to allow chaining.
    129129     */
    130130    close: function( options ) {
     
    165165    },
    166166    /**
    167      * @returns {wp.media.view.Modal} Returns itself to allow chaining
     167     * @returns {wp.media.view.Modal} Returns itself to allow chaining.
    168168     */
    169169    escape: function() {
     
    180180    /**
    181181     * @param {Array|Object} content Views to register to '.media-modal-content'
    182      * @returns {wp.media.view.Modal} Returns itself to allow chaining
     182     * @returns {wp.media.view.Modal} Returns itself to allow chaining.
    183183     */
    184184    content: function( content ) {
     
    192192     *
    193193     * @param {string} id
    194      * @returns {wp.media.view.Modal} Returns itself to allow chaining
     194     * @returns {wp.media.view.Modal} Returns itself to allow chaining.
    195195     */
    196196    propagate: function( id ) {
  • trunk/src/js/media/views/priority-list.js

    r43309 r46799  
    2626     * @param {wp.media.View|Object} view
    2727     * @param {Object} options
    28      * @returns {wp.media.view.PriorityList} Returns itself to allow chaining
     28     * @returns {wp.media.view.PriorityList} Returns itself to allow chaining.
    2929     */
    3030    set: function( id, view, options ) {
  • trunk/src/js/media/views/search.js

    r46418 r46799  
    2525
    2626    /**
    27      * @returns {wp.media.view.Search} Returns itself to allow chaining
     27     * @returns {wp.media.view.Search} Returns itself to allow chaining.
    2828     */
    2929    render: function() {
  • trunk/src/js/media/views/settings.js

    r46748 r46799  
    3232    },
    3333    /**
    34      * @returns {wp.media.view.Settings} Returns itself to allow chaining
     34     * @returns {wp.media.view.Settings} Returns itself to allow chaining.
    3535     */
    3636    render: function() {
  • trunk/src/js/media/views/settings/attachment-display.js

    r45524 r46799  
    4343    },
    4444    /**
    45      * @returns {wp.media.view.AttachmentDisplay} Returns itself to allow chaining
     45     * @returns {wp.media.view.AttachmentDisplay} Returns itself to allow chaining.
    4646     */
    4747    render: function() {
  • trunk/src/js/media/views/toolbar.js

    r43309 r46799  
    7575     * @param {Backbone.View|Object} view
    7676     * @param {Object} [options={}]
    77      * @returns {wp.media.view.Toolbar} Returns itself to allow chaining
     77     * @returns {wp.media.view.Toolbar} Returns itself to allow chaining.
    7878     */
    7979    set: function( id, view, options ) {
     
    117117     * @param {string} id
    118118     * @param {Object} options
    119      * @returns {wp.media.view.Toolbar} Returns itself to allow chaining
     119     * @returns {wp.media.view.Toolbar} Returns itself to allow chaining.
    120120     */
    121121    unset: function( id, options ) {
  • trunk/src/js/media/views/uploader/inline.js

    r43309 r46799  
    6161    },
    6262    /**
    63      * @returns {wp.media.view.UploaderInline} Returns itself to allow chaining
     63     * @returns {wp.media.view.UploaderInline} Returns itself to allow chaining.
    6464     */
    6565    dispose: function() {
     
    7878    },
    7979    /**
    80      * @returns {wp.media.view.UploaderInline} Returns itself to allow chaining
     80     * @returns {wp.media.view.UploaderInline} Returns itself to allow chaining.
    8181     */
    8282    remove: function() {
  • trunk/src/js/media/views/view.js

    r43309 r46799  
    2929     *       care of this in Backbone.View now.
    3030     *
    31      * @returns {wp.media.View} Returns itself to allow chaining
     31     * @returns {wp.media.View} Returns itself to allow chaining.
    3232     */
    3333    dispose: function() {
     
    5353    },
    5454    /**
    55      * @returns {wp.media.View} Returns itself to allow chaining
     55     * @returns {wp.media.View} Returns itself to allow chaining.
    5656     */
    5757    remove: function() {
Note: See TracChangeset for help on using the changeset viewer.