WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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

Props shital-patel, kalpshit.
Fixes #48305.
Built from https://develop.svn.wordpress.org/trunk@46799


git-svn-id: http://core.svn.wordpress.org/trunk@46599 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2019-11-29 16:56:02 +00:00
parent acd0a3ca99
commit 4a4afbd68c
10 changed files with 67 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-admin/js/color-picker.js
View File

@ -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 ) {

12
wp-admin/js/customize-controls.js
View File

@ -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 );

6
wp-admin/js/customize-nav-menus.js
View File

@ -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,

10
wp-admin/js/customize-widgets.js
View File

@ -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,

4
wp-admin/js/editor.js
View File

@ -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.

2
wp-includes/js/media-audiovideo.js
View File

@ -995,7 +995,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 );

2
wp-includes/js/media-editor.js
View File

@ -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 ] ) ) {

12
wp-includes/js/media-models.js
View File

@ -696,7 +696,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 ),
@ -719,7 +719,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 || {};
@ -753,7 +753,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 ) {
@ -776,7 +776,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,
@ -792,7 +792,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 );
@ -802,7 +802,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 ) {

82
wp-includes/js/media-views.js
View File

@ -334,7 +334,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.
@ -390,7 +390,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 ) {
@ -502,7 +502,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();
@ -2685,7 +2685,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
@ -2709,7 +2709,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();
@ -2809,7 +2809,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' );
@ -3044,7 +3044,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.
@ -3217,35 +3217,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 ) {
@ -4438,7 +4438,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 ) {
@ -4459,7 +4459,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') ) {
@ -4472,7 +4472,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,
@ -4516,7 +4516,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') ) {
@ -4555,7 +4555,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 });
@ -4570,7 +4570,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 );
@ -4582,7 +4582,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 );
@ -5389,7 +5389,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 ) {
@ -5406,7 +5406,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() {
/**
@ -5714,7 +5714,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;
@ -5756,7 +5756,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 ];
@ -5974,7 +5974,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 ],
@ -6096,7 +6096,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;
@ -6221,7 +6221,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,
@ -6565,7 +6565,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;
@ -6583,7 +6583,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(), {
@ -6930,7 +6930,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' };
@ -7025,7 +7025,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
@ -7034,7 +7034,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
@ -7043,7 +7043,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
@ -7052,7 +7052,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 + '"]');
@ -7611,7 +7611,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');
@ -8090,7 +8090,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 );
@ -8720,7 +8720,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 );
@ -8862,7 +8862,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;
@ -9218,7 +9218,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 ) {
@ -9230,7 +9230,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');
@ -9292,7 +9292,7 @@ module.exports = AttachmentCompat;
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();
@ -9452,7 +9452,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;

2
wp-includes/version.php
View File

@ -13,7 +13,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.4-alpha-46797';
$wp_version = '5.4-alpha-46799';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.