IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Remove extra spaces from @param tags.

Browse Source 
Per the documentation standards, `@param` tags should be aligned with each other, but not with the `@return` tag.

See #49572.
Built from https://develop.svn.wordpress.org/trunk@48110


git-svn-id: http://core.svn.wordpress.org/trunk@47879 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov
2020-06-20 12:58:10 +00:00
parent b16368c268
commit be16bb9fba
35 changed files with 181 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
wp-includes/js/customize-base.js
View File

@@ -17,10 +17,10 @@ window.wp = window.wp || {};
* Similar to `goog.inherits`, but uses a hash of prototype properties and
* class properties to be extended.
*
* @param object parent Parent class constructor to inherit from.
* @param object protoProps Properties to apply to the prototype for use as class instance properties.
* @param object staticProps Properties to apply directly to the class constructor.
* @return child The subclassed constructor.
* @param object parent Parent class constructor to inherit from.
* @param object protoProps Properties to apply to the prototype for use as class instance properties.
* @param object staticProps Properties to apply directly to the class constructor.
* @return child The subclassed constructor.
*/
inherits = function( parent, protoProps, staticProps ) {
var child;
@@ -108,9 +108,9 @@ window.wp = window.wp || {};
/**
* Creates a subclass of the class.
*
* @param object protoProps Properties to apply to the prototype.
* @param object staticProps Properties to apply directly to the class.
* @return child The subclass.
* @param object protoProps Properties to apply to the prototype.
* @param object staticProps Properties to apply directly to the class.
* @return child The subclass.
*/
api.Class.extend = function( protoProps, classProps ) {
var child = inherits( this, protoProps, classProps );
@@ -354,11 +354,11 @@ window.wp = window.wp || {};
*
* @see {api.Values.when}
*
* @param {string} id ID of the item.
* @param {...} Zero or more IDs of items to wait for and a callback
* function to invoke when they're available. Optional.
* @return {mixed} The item instance if only one ID was supplied.
* A Deferred Promise object if a callback function is supplied.
* @param {string} id ID of the item.
* @param {...} Zero or more IDs of items to wait for and a callback
* function to invoke when they're available. Optional.
* @return {mixed} The item instance if only one ID was supplied.
* A Deferred Promise object if a callback function is supplied.
*/
instance: function( id ) {
if ( arguments.length === 1 ) {
@@ -371,8 +371,8 @@ window.wp = window.wp || {};
/**
* Get the instance of an item.
*
* @param {string} id The ID of the item.
* @return {[type]} [description]
* @param {string} id The ID of the item.
* @return {[type]} [description]
*/
value: function( id ) {
return this._value[ id ];
@@ -381,7 +381,7 @@ window.wp = window.wp || {};
/**
* Whether the collection has an item with the given ID.
*
* @param {string} id The ID of the item to look for.
* @param {string} id The ID of the item to look for.
* @return {Boolean}
*/
has: function( id ) {
@@ -435,9 +435,9 @@ window.wp = window.wp || {};
* Create a new item of the collection using the collection's default constructor
* and store it in the collection.
*
* @param {string} id The ID of the item.
* @param {mixed} value Any extra arguments are passed into the item's initialize method.
* @return {mixed} The new item's instance.
* @param {string} id The ID of the item.
* @param {mixed} value Any extra arguments are passed into the item's initialize method.
* @return {mixed} The new item's instance.
*/
create: function( id ) {
return this.add( id, new this.defaultConstructor( api.Class.applicator, slice.call( arguments, 1 ) ) );
@@ -446,8 +446,8 @@ window.wp = window.wp || {};
/**
* Iterate over all items in the collection invoking the provided callback.
*
* @param {Function} callback Function to invoke.
* @param {object} context Object context to invoke the function with. Optional.
* @param {Function} callback Function to invoke.
* @param {object} context Object context to invoke the function with. Optional.
*/
each: function( callback, context ) {
context = typeof context === 'undefined' ? this : context;
@@ -460,7 +460,7 @@ window.wp = window.wp || {};
/**
* Remove an item from the collection.
*
* @param {string} id The ID of the item to remove.
* @param {string} id The ID of the item to remove.
*/
remove: function( id ) {
var value = this.value( id );
@@ -670,10 +670,10 @@ window.wp = window.wp || {};
/**
* Create a new Value.
*
* @param {string} key Unique identifier.
* @param {mixed} initial Initial value.
* @param {mixed} options Options hash. Optional.
* @return {Value} Class instance of the Value.
* @param {string} key Unique identifier.
* @param {mixed} initial Initial value.
* @param {mixed} options Options hash. Optional.
* @return {Value} Class instance of the Value.
*/
add: function( key, initial, options ) {
return this[ key ] = new api.Value( initial, options );
@@ -682,11 +682,11 @@ window.wp = window.wp || {};
/**
* Initialize Messenger.
*
* @param {object} params - Parameters to configure the messenger.
* {string} params.url - The URL to communicate with.
* {window} params.targetWindow - The window instance to communicate with. Default window.parent.
* {string} params.channel - If provided, will send the channel with each message and only accept messages a matching channel.
* @param {object} options - Extend any instance parameter or method with this object.
* @param {object} params - Parameters to configure the messenger.
* {string} params.url - The URL to communicate with.
* {window} params.targetWindow - The window instance to communicate with. Default window.parent.
* {string} params.channel - If provided, will send the channel with each message and only accept messages a matching channel.
* @param {object} options - Extend any instance parameter or method with this object.
*/
initialize: function( params, options ) {
// Target the parent frame by default, but only if a parent frame exists.
@@ -747,7 +747,7 @@ window.wp = window.wp || {};
/**
* Receive data from the other window.
*
* @param {jQuery.Event} event Event with embedded data.
* @param {jQuery.Event} event Event with embedded data.
*/
receive: function( event ) {
var message;
@@ -786,8 +786,8 @@ window.wp = window.wp || {};
/**
* Send data to the other window.
*
* @param {string} id The event name.
* @param {object} data Data.
* @param {string} id The event name.
* @param {object} data Data.
*/
send: function( id, data ) {
var message;