diff options
author | Sergey Biryukov <sergeybiryukov@git.wordpress.org> | 2019-11-29 16:55:01 +0000 |
---|---|---|
committer | Sergey Biryukov <sergeybiryukov@git.wordpress.org> | 2019-11-29 16:55:01 +0000 |
commit | ea5bfe134f50b91680369f50b4d12d233b1f917c (patch) | |
tree | a5378fdd0701937a619f485f7b7d203a675979b0 | |
parent | 4b60e6a0db3e47ec018a8d9900e48cf7e70e0866 (diff) | |
download | wordpress-ea5bfe134f50b91680369f50b4d12d233b1f917c.tar.gz wordpress-ea5bfe134f50b91680369f50b4d12d233b1f917c.zip |
Docs: Add missing full stops to `@returns` tags in JS docs, per the documentation standards.
Props shital-patel, kalpshit.
Fixes #48305.
git-svn-id: https://develop.svn.wordpress.org/trunk@46799 602fd350-edb4-49c9-b593-d223f7449a82
27 files changed, 66 insertions, 66 deletions
diff --git a/src/js/_enqueues/lib/color-picker.js b/src/js/_enqueues/lib/color-picker.js index 89e6db04a3..5206e39f1d 100644 --- a/src/js/_enqueues/lib/color-picker.js +++ b/src/js/_enqueues/lib/color-picker.js @@ -327,7 +327,7 @@ * * @since 3.5.0 * - * @returns {string} The element's color + * @returns {string} The element's color. */ color: function( newColor ) { if ( newColor === undef ) { diff --git a/src/js/_enqueues/wp/customize/controls.js b/src/js/_enqueues/wp/customize/controls.js index 0a131d188f..d9b7978394 100644 --- a/src/js/_enqueues/wp/customize/controls.js +++ b/src/js/_enqueues/wp/customize/controls.js @@ -1154,7 +1154,7 @@ * * @param {Boolean} active * @param {Object} [params] - * @returns {Boolean} false if state already applied + * @returns {Boolean} False if state already applied. */ _toggleActive: function ( active, params ) { var self = this; @@ -1173,7 +1173,7 @@ /** * @param {Object} [params] - * @returns {Boolean} false if already active + * @returns {Boolean} False if already active. */ activate: function ( params ) { return this._toggleActive( true, params ); @@ -1181,7 +1181,7 @@ /** * @param {Object} [params] - * @returns {Boolean} false if already inactive + * @returns {Boolean} False if already inactive. */ deactivate: function ( params ) { return this._toggleActive( false, params ); @@ -1201,7 +1201,7 @@ * @param {Boolean} expanded - The new state to apply. * @param {Object} [params] - Object containing options for expand/collapse. * @param {Function} [params.completeCallback] - Function to call when expansion/collapse is complete. - * @returns {Boolean} false if state already applied or active state is false + * @returns {Boolean} False if state already applied or active state is false. */ _toggleExpanded: function( expanded, params ) { var instance = this, previousCompleteCallback; @@ -1238,7 +1238,7 @@ /** * @param {Object} [params] - * @returns {Boolean} false if already expanded or if inactive. + * @returns {Boolean} False if already expanded or if inactive. */ expand: function ( params ) { return this._toggleExpanded( true, params ); @@ -1246,7 +1246,7 @@ /** * @param {Object} [params] - * @returns {Boolean} false if already collapsed. + * @returns {Boolean} False if already collapsed. */ collapse: function ( params ) { return this._toggleExpanded( false, params ); diff --git a/src/js/_enqueues/wp/customize/nav-menus.js b/src/js/_enqueues/wp/customize/nav-menus.js index 19f0d2060f..fe58cb58da 100644 --- a/src/js/_enqueues/wp/customize/nav-menus.js +++ b/src/js/_enqueues/wp/customize/nav-menus.js @@ -1962,7 +1962,7 @@ * * @param {Boolean} expanded * @param {Object} [params] - * @returns {Boolean} false if state already applied + * @returns {Boolean} False if state already applied. */ _toggleExpanded: api.Section.prototype._toggleExpanded, @@ -1970,7 +1970,7 @@ * @since 4.6.0 * * @param {Object} [params] - * @returns {Boolean} false if already expanded + * @returns {Boolean} False if already expanded. */ expand: api.Section.prototype.expand, @@ -1990,7 +1990,7 @@ * @since 4.6.0 * * @param {Object} [params] - * @returns {Boolean} false if already collapsed + * @returns {Boolean} False if already collapsed. */ collapse: api.Section.prototype.collapse, diff --git a/src/js/_enqueues/wp/customize/widgets.js b/src/js/_enqueues/wp/customize/widgets.js index 1506a31b8a..5a0fbf2c3c 100644 --- a/src/js/_enqueues/wp/customize/widgets.js +++ b/src/js/_enqueues/wp/customize/widgets.js @@ -1340,7 +1340,7 @@ * * @param {Boolean} expanded * @param {Object} [params] - * @returns {Boolean} false if state already applied + * @returns {Boolean} False if state already applied. */ _toggleExpanded: api.Section.prototype._toggleExpanded, @@ -1348,7 +1348,7 @@ * @since 4.1.0 * * @param {Object} [params] - * @returns {Boolean} false if already expanded + * @returns {Boolean} False if already expanded. */ expand: api.Section.prototype.expand, @@ -1365,7 +1365,7 @@ * @since 4.1.0 * * @param {Object} [params] - * @returns {Boolean} false if already collapsed + * @returns {Boolean} False if already collapsed. */ collapse: api.Section.prototype.collapse, @@ -2060,8 +2060,8 @@ }, /** - * @param {string} widgetId or an id_base for adding a previously non-existing widget - * @returns {object|false} widget_form control instance, or false on error + * @param {string} widgetId or an id_base for adding a previously non-existing widget. + * @returns {object|false} widget_form control instance, or false on error. */ addWidget: function( widgetId ) { var self = this, controlHtml, $widget, controlType = 'widget_form', controlContainer, controlConstructor, diff --git a/src/js/_enqueues/wp/editor/base.js b/src/js/_enqueues/wp/editor/base.js index 0620b312de..050f24692d 100644 --- a/src/js/_enqueues/wp/editor/base.js +++ b/src/js/_enqueues/wp/editor/base.js @@ -658,8 +658,8 @@ window.wp = window.wp || {}; * Check the notes in the comments in the code below for more information on some gotchas * and why this solution was chosen. * - * @param {Object} editor The editor where we must find the selection - * @returns {(null|Object)} The selection range position in the editor + * @param {Object} editor The editor where we must find the selection. + * @returns {(null|Object)} The selection range position in the editor. */ function findBookmarkedPosition( editor ) { // Get the TinyMCE `window` reference, since we need to access the raw selection. diff --git a/src/js/_enqueues/wp/media/editor.js b/src/js/_enqueues/wp/media/editor.js index fdd0cf78a5..2b4055aea3 100644 --- a/src/js/_enqueues/wp/media/editor.js +++ b/src/js/_enqueues/wp/media/editor.js @@ -21,7 +21,7 @@ * * @param {object} attrs Map of props from a shortcode or settings. * @param {string} key The key within the passed map to check for a value. - * @returns {mixed|undefined} The original or coerced value of key within attrs + * @returns {mixed|undefined} The original or coerced value of key within attrs. */ wp.media.coerce = function ( attrs, key ) { if ( _.isUndefined( attrs[ key ] ) && ! _.isUndefined( this.defaults[ key ] ) ) { diff --git a/src/js/media/controllers/region.js b/src/js/media/controllers/region.js index 6c0e27e7b3..0973e68d0c 100644 --- a/src/js/media/controllers/region.js +++ b/src/js/media/controllers/region.js @@ -77,7 +77,7 @@ _.extend( Region.prototype,/** @lends wp.media.controller.Region.prototype */{ * @fires Region#create * @fires Region#render * - * @returns {wp.media.controller.Region} Returns itself to allow chaining + * @returns {wp.media.controller.Region} Returns itself to allow chaining. */ render: function( mode ) { // If the mode isn't active, activate it. @@ -133,7 +133,7 @@ _.extend( Region.prototype,/** @lends wp.media.controller.Region.prototype */{ * * @param {Array|Object} views * @param {Object} [options={}] - * @returns {wp.Backbone.Subviews} Subviews is returned to allow chaining + * @returns {wp.Backbone.Subviews} Subviews is returned to allow chaining. */ set: function( views, options ) { if ( options ) { diff --git a/src/js/media/controllers/state-machine.js b/src/js/media/controllers/state-machine.js index bb7fb31b27..9ddeca5da4 100644 --- a/src/js/media/controllers/state-machine.js +++ b/src/js/media/controllers/state-machine.js @@ -65,7 +65,7 @@ _.extend( StateMachine.prototype, Backbone.Events,/** @lends wp.media.controller * @fires wp.media.controller.State#deactivate * @fires wp.media.controller.State#activate * - * @returns {wp.media.controller.StateMachine} Returns itself to allow chaining + * @returns {wp.media.controller.StateMachine} Returns itself to allow chaining. */ setState: function( id ) { var previous = this.state(); diff --git a/src/js/media/models/attachments.js b/src/js/media/models/attachments.js index 82b365fac4..d0234e52f1 100644 --- a/src/js/media/models/attachments.js +++ b/src/js/media/models/attachments.js @@ -172,7 +172,7 @@ var Attachments = Backbone.Collection.extend(/** @lends wp.media.model.Attachmen * * @param {wp.media.model.Attachment} attachment * @param {Object} options - * @returns {wp.media.model.Attachments} Returns itself to allow chaining + * @returns {wp.media.model.Attachments} Returns itself to allow chaining. */ validate: function( attachment, options ) { var valid = this.validator( attachment ), @@ -195,7 +195,7 @@ var Attachments = Backbone.Collection.extend(/** @lends wp.media.model.Attachmen * * @fires wp.media.model.Attachments#reset * - * @returns {wp.media.model.Attachments} Returns itself to allow chaining + * @returns {wp.media.model.Attachments} Returns itself to allow chaining. */ validateAll: function( attachments, options ) { options = options || {}; @@ -229,7 +229,7 @@ var Attachments = Backbone.Collection.extend(/** @lends wp.media.model.Attachmen * Stop replicating collection change events from another attachments collection. * * @param {wp.media.model.Attachments} The attachments collection to stop observing. - * @returns {wp.media.model.Attachments} Returns itself to allow chaining + * @returns {wp.media.model.Attachments} Returns itself to allow chaining. */ unobserve: function( attachments ) { if ( attachments ) { @@ -252,7 +252,7 @@ var Attachments = Backbone.Collection.extend(/** @lends wp.media.model.Attachmen * @param {wp.media.model.Attachments} attachments * @param {Object} options * - * @returns {wp.media.model.Attachments} Returns itself to allow chaining + * @returns {wp.media.model.Attachments} Returns itself to allow chaining. */ _validateHandler: function( attachment, attachments, options ) { // If we're not mirroring this `attachments` collection, @@ -268,7 +268,7 @@ var Attachments = Backbone.Collection.extend(/** @lends wp.media.model.Attachmen * * @param {wp.media.model.Attachments} attachments * @param {Object} options - * @returns {wp.media.model.Attachments} Returns itself to allow chaining + * @returns {wp.media.model.Attachments} Returns itself to allow chaining. */ _validateAllHandler: function( attachments, options ) { return this.validateAll( attachments, options ); @@ -278,7 +278,7 @@ var Attachments = Backbone.Collection.extend(/** @lends wp.media.model.Attachmen * in the collection. * * @param {wp.media.model.Attachments} The attachments collection to mirror. - * @returns {wp.media.model.Attachments} Returns itself to allow chaining + * @returns {wp.media.model.Attachments} Returns itself to allow chaining. */ mirror: function( attachments ) { if ( this.mirroring && this.mirroring === attachments ) { diff --git a/src/js/media/views/attachment-compat.js b/src/js/media/views/attachment-compat.js index d995d231bf..5c2d72a58f 100644 --- a/src/js/media/views/attachment-compat.js +++ b/src/js/media/views/attachment-compat.js @@ -28,7 +28,7 @@ AttachmentCompat = View.extend(/** @lends wp.media.view.AttachmentCompat.prototy this.listenTo( this.model, 'change:compat', this.render ); }, /** - * @returns {wp.media.view.AttachmentCompat} Returns itself to allow chaining + * @returns {wp.media.view.AttachmentCompat} Returns itself to allow chaining. */ dispose: function() { if ( this.$(':focus').length ) { @@ -40,7 +40,7 @@ AttachmentCompat = View.extend(/** @lends wp.media.view.AttachmentCompat.prototy return View.prototype.dispose.apply( this, arguments ); }, /** - * @returns {wp.media.view.AttachmentCompat} Returns itself to allow chaining + * @returns {wp.media.view.AttachmentCompat} Returns itself to allow chaining. */ render: function() { var compat = this.model.get('compat'); diff --git a/src/js/media/views/attachment.js b/src/js/media/views/attachment.js index 14d5e460db..e7aae2f1a2 100644 --- a/src/js/media/views/attachment.js +++ b/src/js/media/views/attachment.js @@ -69,7 +69,7 @@ Attachment = View.extend(/** @lends wp.media.view.Attachment.prototype */{ this.listenTo( this.controller.states, 'attachment:compat:waiting attachment:compat:ready', this.updateSave ); }, /** - * @returns {wp.media.view.Attachment} Returns itself to allow chaining + * @returns {wp.media.view.Attachment} Returns itself to allow chaining. */ dispose: function() { var selection = this.options.selection; @@ -87,7 +87,7 @@ Attachment = View.extend(/** @lends wp.media.view.Attachment.prototype */{ return this; }, /** - * @returns {wp.media.view.Attachment} Returns itself to allow chaining + * @returns {wp.media.view.Attachment} Returns itself to allow chaining. */ render: function() { var options = _.defaults( this.model.toJSON(), { @@ -434,7 +434,7 @@ Attachment = View.extend(/** @lends wp.media.view.Attachment.prototype */{ }, /** * @param {string} status - * @returns {wp.media.view.Attachment} Returns itself to allow chaining + * @returns {wp.media.view.Attachment} Returns itself to allow chaining. */ updateSave: function( status ) { var save = this._save = this._save || { status: 'ready' }; @@ -529,7 +529,7 @@ _.each({ * * @param {Backbone.Model} model * @param {string} value - * @returns {wp.media.view.Attachment} Returns itself to allow chaining + * @returns {wp.media.view.Attachment} Returns itself to allow chaining. */ /** * @function _syncTitle @@ -538,7 +538,7 @@ _.each({ * * @param {Backbone.Model} model * @param {string} value - * @returns {wp.media.view.Attachment} Returns itself to allow chaining + * @returns {wp.media.view.Attachment} Returns itself to allow chaining. */ /** * @function _syncArtist @@ -547,7 +547,7 @@ _.each({ * * @param {Backbone.Model} model * @param {string} value - * @returns {wp.media.view.Attachment} Returns itself to allow chaining + * @returns {wp.media.view.Attachment} Returns itself to allow chaining. */ /** * @function _syncAlbum @@ -556,7 +556,7 @@ _.each({ * * @param {Backbone.Model} model * @param {string} value - * @returns {wp.media.view.Attachment} Returns itself to allow chaining + * @returns {wp.media.view.Attachment} Returns itself to allow chaining. */ Attachment.prototype[ method ] = function( model, value ) { var $setting = this.$('[data-setting="' + setting + '"]'); diff --git a/src/js/media/views/attachments/browser.js b/src/js/media/views/attachments/browser.js index a757a47f50..85ecfde14a 100644 --- a/src/js/media/views/attachments/browser.js +++ b/src/js/media/views/attachments/browser.js @@ -123,7 +123,7 @@ AttachmentsBrowser = View.extend(/** @lends wp.media.view.AttachmentsBrowser.pro }, /** - * @returns {wp.media.view.AttachmentsBrowser} Returns itself to allow chaining + * @returns {wp.media.view.AttachmentsBrowser} Returns itself to allow chaining. */ dispose: function() { this.options.selection.off( null, null, this ); diff --git a/src/js/media/views/button.js b/src/js/media/views/button.js index 8f1af79d85..bde40f6463 100644 --- a/src/js/media/views/button.js +++ b/src/js/media/views/button.js @@ -47,7 +47,7 @@ var Button = wp.media.View.extend(/** @lends wp.media.view.Button.prototype */{ this.listenTo( this.model, 'change', this.render ); }, /** - * @returns {wp.media.view.Button} Returns itself to allow chaining + * @returns {wp.media.view.Button} Returns itself to allow chaining. */ render: function() { var classes = [ 'button', this.className ], diff --git a/src/js/media/views/embed/url.js b/src/js/media/views/embed/url.js index 4585e2ba89..1c80ee5b4f 100644 --- a/src/js/media/views/embed/url.js +++ b/src/js/media/views/embed/url.js @@ -39,7 +39,7 @@ EmbedUrl = View.extend(/** @lends wp.media.view.EmbedUrl.prototype */{ } }, /** - * @returns {wp.media.view.EmbedUrl} Returns itself to allow chaining + * @returns {wp.media.view.EmbedUrl} Returns itself to allow chaining. */ render: function() { var $input = this.$input; diff --git a/src/js/media/views/frame.js b/src/js/media/views/frame.js index 9c85811099..bd7a5c5786 100644 --- a/src/js/media/views/frame.js +++ b/src/js/media/views/frame.js @@ -80,7 +80,7 @@ var Frame = wp.media.View.extend(/** @lends wp.media.view.Frame.prototype */{ /** * Reset all states on the frame to their defaults. * - * @returns {wp.media.view.Frame} Returns itself to allow chaining + * @returns {wp.media.view.Frame} Returns itself to allow chaining. */ reset: function() { this.states.invoke( 'trigger', 'reset' ); diff --git a/src/js/media/views/iframe.js b/src/js/media/views/iframe.js index a8f5a6edb8..685a13cb06 100644 --- a/src/js/media/views/iframe.js +++ b/src/js/media/views/iframe.js @@ -11,7 +11,7 @@ var Iframe = wp.media.View.extend(/** @lends wp.media.view.Iframe.prototype */{ className: 'media-iframe', /** - * @returns {wp.media.view.Iframe} Returns itself to allow chaining + * @returns {wp.media.view.Iframe} Returns itself to allow chaining. */ render: function() { this.views.detach(); diff --git a/src/js/media/views/media-details.js b/src/js/media/views/media-details.js index ae643a3941..093bb9cc15 100644 --- a/src/js/media/views/media-details.js +++ b/src/js/media/views/media-details.js @@ -123,7 +123,7 @@ MediaDetails = AttachmentDisplay.extend(/** @lends wp.media.view.MediaDetails.pr }, /** - * @returns {media.view.MediaDetails} Returns itself to allow chaining + * @returns {media.view.MediaDetails} Returns itself to allow chaining. */ render: function() { AttachmentDisplay.prototype.render.apply( this, arguments ); diff --git a/src/js/media/views/media-frame.js b/src/js/media/views/media-frame.js index 4866e62f2e..0d5e64a12e 100644 --- a/src/js/media/views/media-frame.js +++ b/src/js/media/views/media-frame.js @@ -143,7 +143,7 @@ MediaFrame = Frame.extend(/** @lends wp.media.view.MediaFrame.prototype */{ }, /** - * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining + * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining. */ render: function() { // Activate the default state if no active state exists. @@ -316,35 +316,35 @@ _.each(['open','close','attach','detach','escape'], function( method ) { * @memberOf wp.media.view.MediaFrame * @instance * - * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining + * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining. */ /** * @function close * @memberOf wp.media.view.MediaFrame * @instance * - * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining + * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining. */ /** * @function attach * @memberOf wp.media.view.MediaFrame * @instance * - * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining + * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining. */ /** * @function detach * @memberOf wp.media.view.MediaFrame * @instance * - * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining + * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining. */ /** * @function escape * @memberOf wp.media.view.MediaFrame * @instance * - * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining + * @returns {wp.media.view.MediaFrame} Returns itself to allow chaining. */ MediaFrame.prototype[ method ] = function() { if ( this.modal ) { diff --git a/src/js/media/views/menu-item.js b/src/js/media/views/menu-item.js index 459c0f6019..e4b022cc74 100644 --- a/src/js/media/views/menu-item.js +++ b/src/js/media/views/menu-item.js @@ -47,7 +47,7 @@ MenuItem = wp.media.View.extend(/** @lends wp.media.view.MenuItem.prototype */{ }, /** - * @returns {wp.media.view.MenuItem} returns itself to allow chaining + * @returns {wp.media.view.MenuItem} returns itself to allow chaining. */ render: function() { var options = this.options, diff --git a/src/js/media/views/modal.js b/src/js/media/views/modal.js index 463290dba9..b823e2f868 100644 --- a/src/js/media/views/modal.js +++ b/src/js/media/views/modal.js @@ -47,7 +47,7 @@ Modal = wp.media.View.extend(/** @lends wp.media.view.Modal.prototype */{ }, /** - * @returns {wp.media.view.Modal} Returns itself to allow chaining + * @returns {wp.media.view.Modal} Returns itself to allow chaining. */ attach: function() { if ( this.views.attached ) { @@ -68,7 +68,7 @@ Modal = wp.media.View.extend(/** @lends wp.media.view.Modal.prototype */{ }, /** - * @returns {wp.media.view.Modal} Returns itself to allow chaining + * @returns {wp.media.view.Modal} Returns itself to allow chaining. */ detach: function() { if ( this.$el.is(':visible') ) { @@ -81,7 +81,7 @@ Modal = wp.media.View.extend(/** @lends wp.media.view.Modal.prototype */{ }, /** - * @returns {wp.media.view.Modal} Returns itself to allow chaining + * @returns {wp.media.view.Modal} Returns itself to allow chaining. */ open: function() { var $el = this.$el, @@ -125,7 +125,7 @@ Modal = wp.media.View.extend(/** @lends wp.media.view.Modal.prototype */{ /** * @param {Object} options - * @returns {wp.media.view.Modal} Returns itself to allow chaining + * @returns {wp.media.view.Modal} Returns itself to allow chaining. */ close: function( options ) { if ( ! this.views.attached || ! this.$el.is(':visible') ) { @@ -164,7 +164,7 @@ Modal = wp.media.View.extend(/** @lends wp.media.view.Modal.prototype */{ return this; }, /** - * @returns {wp.media.view.Modal} Returns itself to allow chaining + * @returns {wp.media.view.Modal} Returns itself to allow chaining. */ escape: function() { return this.close({ escape: true }); @@ -179,7 +179,7 @@ Modal = wp.media.View.extend(/** @lends wp.media.view.Modal.prototype */{ /** * @param {Array|Object} content Views to register to '.media-modal-content' - * @returns {wp.media.view.Modal} Returns itself to allow chaining + * @returns {wp.media.view.Modal} Returns itself to allow chaining. */ content: function( content ) { this.views.set( '.media-modal-content', content ); @@ -191,7 +191,7 @@ Modal = wp.media.View.extend(/** @lends wp.media.view.Modal.prototype */{ * forwards events to the modal's controller. * * @param {string} id - * @returns {wp.media.view.Modal} Returns itself to allow chaining + * @returns {wp.media.view.Modal} Returns itself to allow chaining. */ propagate: function( id ) { this.trigger( id ); diff --git a/src/js/media/views/priority-list.js b/src/js/media/views/priority-list.js index 16533e842d..8a3ff50601 100644 --- a/src/js/media/views/priority-list.js +++ b/src/js/media/views/priority-list.js @@ -25,7 +25,7 @@ var PriorityList = wp.media.View.extend(/** @lends wp.media.view.PriorityList.pr * @param {string} id * @param {wp.media.View|Object} view * @param {Object} options - * @returns {wp.media.view.PriorityList} Returns itself to allow chaining + * @returns {wp.media.view.PriorityList} Returns itself to allow chaining. */ set: function( id, view, options ) { var priority, views, index; diff --git a/src/js/media/views/search.js b/src/js/media/views/search.js index b57c9eadb5..f774943877 100644 --- a/src/js/media/views/search.js +++ b/src/js/media/views/search.js @@ -24,7 +24,7 @@ Search = wp.media.View.extend(/** @lends wp.media.view.Search.prototype */{ }, /** - * @returns {wp.media.view.Search} Returns itself to allow chaining + * @returns {wp.media.view.Search} Returns itself to allow chaining. */ render: function() { this.el.value = this.model.escape('search'); diff --git a/src/js/media/views/settings.js b/src/js/media/views/settings.js index 626a038e50..6838e38114 100644 --- a/src/js/media/views/settings.js +++ b/src/js/media/views/settings.js @@ -31,7 +31,7 @@ Settings = View.extend(/** @lends wp.media.view.Settings.prototype */{ }, this.options ); }, /** - * @returns {wp.media.view.Settings} Returns itself to allow chaining + * @returns {wp.media.view.Settings} Returns itself to allow chaining. */ render: function() { View.prototype.render.apply( this, arguments ); diff --git a/src/js/media/views/settings/attachment-display.js b/src/js/media/views/settings/attachment-display.js index 31bf4f6f0d..7ca3751c08 100644 --- a/src/js/media/views/settings/attachment-display.js +++ b/src/js/media/views/settings/attachment-display.js @@ -42,7 +42,7 @@ AttachmentDisplay = Settings.extend(/** @lends wp.media.view.Settings.Attachment Settings.prototype.dispose.apply( this, arguments ); }, /** - * @returns {wp.media.view.AttachmentDisplay} Returns itself to allow chaining + * @returns {wp.media.view.AttachmentDisplay} Returns itself to allow chaining. */ render: function() { var attachment = this.options.attachment; diff --git a/src/js/media/views/toolbar.js b/src/js/media/views/toolbar.js index 258d12697a..0cece6db5e 100644 --- a/src/js/media/views/toolbar.js +++ b/src/js/media/views/toolbar.js @@ -74,7 +74,7 @@ Toolbar = View.extend(/** @lends wp.media.view.Toolbar.prototype */{ * @param {string} id * @param {Backbone.View|Object} view * @param {Object} [options={}] - * @returns {wp.media.view.Toolbar} Returns itself to allow chaining + * @returns {wp.media.view.Toolbar} Returns itself to allow chaining. */ set: function( id, view, options ) { var list; @@ -116,7 +116,7 @@ Toolbar = View.extend(/** @lends wp.media.view.Toolbar.prototype */{ /** * @param {string} id * @param {Object} options - * @returns {wp.media.view.Toolbar} Returns itself to allow chaining + * @returns {wp.media.view.Toolbar} Returns itself to allow chaining. */ unset: function( id, options ) { delete this._views[ id ]; diff --git a/src/js/media/views/uploader/inline.js b/src/js/media/views/uploader/inline.js index f35e10b84c..2f94210a9b 100644 --- a/src/js/media/views/uploader/inline.js +++ b/src/js/media/views/uploader/inline.js @@ -60,7 +60,7 @@ UploaderInline = View.extend(/** @lends wp.media.view.UploaderInline.prototype * return data; }, /** - * @returns {wp.media.view.UploaderInline} Returns itself to allow chaining + * @returns {wp.media.view.UploaderInline} Returns itself to allow chaining. */ dispose: function() { if ( this.disposing ) { @@ -77,7 +77,7 @@ UploaderInline = View.extend(/** @lends wp.media.view.UploaderInline.prototype * return this.remove(); }, /** - * @returns {wp.media.view.UploaderInline} Returns itself to allow chaining + * @returns {wp.media.view.UploaderInline} Returns itself to allow chaining. */ remove: function() { /** diff --git a/src/js/media/views/view.js b/src/js/media/views/view.js index b5069f2809..9b1f938fca 100644 --- a/src/js/media/views/view.js +++ b/src/js/media/views/view.js @@ -28,7 +28,7 @@ var View = wp.Backbone.View.extend(/** @lends wp.media.View.prototype */{ * before Backbone 0.9.8 came out. Figure out if Backbone core takes * care of this in Backbone.View now. * - * @returns {wp.media.View} Returns itself to allow chaining + * @returns {wp.media.View} Returns itself to allow chaining. */ dispose: function() { // Undelegating events, removing events from the model, and @@ -52,7 +52,7 @@ var View = wp.Backbone.View.extend(/** @lends wp.media.View.prototype */{ return this; }, /** - * @returns {wp.media.View} Returns itself to allow chaining + * @returns {wp.media.View} Returns itself to allow chaining. */ remove: function() { this.dispose(); |