Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-02-06 17:47:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup doc blocks. [ci skip]

Browse Source
This commit is contained in:
jdalton
2015-04-13 20:29:26 -07:00
parent 99f5857d84
commit 5dfee44340
1 changed files with 18 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
lodash.src.js
View File

@@ -2841,7 +2841,7 @@
* *
* @private * @private
* @param {Array|Object|string} collection The collection to iterate over. * @param {Array|Object|string} collection The collection to iterate over.
* @param {Function[]|string[]} iteratees The iteratees to sort by. * @param {Function[]|Object[]|string[]} iteratees The iteratees to sort by.
* @param {boolean[]} orders The sort orders of `iteratees`. * @param {boolean[]} orders The sort orders of `iteratees`.
* @returns {Array} Returns the new sorted array. * @returns {Array} Returns the new sorted array.
*/ */
@@ -6852,7 +6852,6 @@
* @param {Array|Object|string} collection The collection to iterate over. * @param {Array|Object|string} collection The collection to iterate over.
* @param {Function|Object|string} [iteratee=_.identity] The function invoked * @param {Function|Object|string} [iteratee=_.identity] The function invoked
* per iteration. * per iteration.
* create a `_.property` or `_.matches` style callback respectively.
* @param {*} [thisArg] The `this` binding of `iteratee`. * @param {*} [thisArg] The `this` binding of `iteratee`.
* @returns {Array} Returns the new mapped array. * @returns {Array} Returns the new mapped array.
* @example * @example
@@ -7256,9 +7255,8 @@
* @memberOf _ * @memberOf _
* @category Collection * @category Collection
* @param {Array|Object|string} collection The collection to iterate over. * @param {Array|Object|string} collection The collection to iterate over.
* @param {Array|Function|Object|string} [iteratee=_.identity] The function * @param {Function|Object|string} [iteratee=_.identity] The function invoked
* invoked per iteration. If a property name or an object is provided it is * per iteration.
* used to create a `_.property` or `_.matches` style callback respectively.
* @param {*} [thisArg] The `this` binding of `iteratee`. * @param {*} [thisArg] The `this` binding of `iteratee`.
* @returns {Array} Returns the new sorted array. * @returns {Array} Returns the new sorted array.
* @example * @example
@@ -7306,12 +7304,16 @@
* If a property name is provided for an iteratee the created `_.property` * If a property name is provided for an iteratee the created `_.property`
* style callback returns the property value of the given element. * style callback returns the property value of the given element.
* *
* If an object is provided for an iteratee the created `_.matches` style
* callback returns `true` for elements that have the properties of the given
* object, else `false`.
*
* @static * @static
* @memberOf _ * @memberOf _
* @category Collection * @category Collection
* @param {Array|Object|string} collection The collection to iterate over. * @param {Array|Object|string} collection The collection to iterate over.
* @param {...(Function|Function[]|string|string[])} iteratees The iteratees * @param {...(Function|Function[]|Object|Object[]|string|string[])} iteratees
* to sort by, specified as individual values or arrays of values. * The iteratees to sort by, specified as individual values or arrays of values.
* @returns {Array} Returns the new sorted array. * @returns {Array} Returns the new sorted array.
* @example * @example
* *
@@ -7347,11 +7349,18 @@
* sort the corresponding property name in ascending order while a falsey * sort the corresponding property name in ascending order while a falsey
* value will sort it in descending order. * value will sort it in descending order.
* *
* If a property name is provided for an iteratee the created `_.property`
* style callback returns the property value of the given element.
*
* If an object is provided for an iteratee the created `_.matches` style
* callback returns `true` for elements that have the properties of the given
* object, else `false`.
*
* @static * @static
* @memberOf _ * @memberOf _
* @category Collection * @category Collection
* @param {Array|Object|string} collection The collection to iterate over. * @param {Array|Object|string} collection The collection to iterate over.
* @param {Function[]|string[]} iteratees The iteratees to sort by. * @param {Function[]|Object[]|string[]} iteratees The iteratees to sort by.
* @param {boolean[]} orders The sort orders of `iteratees`. * @param {boolean[]} orders The sort orders of `iteratees`.
* @param- {Object} [guard] Enables use as a callback for functions like `_.reduce`. * @param- {Object} [guard] Enables use as a callback for functions like `_.reduce`.
* @returns {Array} Returns the new sorted array. * @returns {Array} Returns the new sorted array.
@@ -11629,7 +11638,7 @@
* _.times(3, function(n) { * _.times(3, function(n) {
* mage.castSpell(n); * mage.castSpell(n);
* }); * });
* // => invokes `mage.castSpell(n)` three times with `n` of `0`, `1`, and `2` respectively * // => invokes `mage.castSpell(n)` three times with `n` of `0`, `1`, and `2`
* *
* _.times(3, function(n) { * _.times(3, function(n) {
* this.cast(n); * this.cast(n);