Cleanup docs for baseMerge, baseMergeDeep, createAggregator, & createAssigner. [ci skip]

This commit is contained in:
jdalton
2015-06-20 09:27:08 -07:00
parent 889c184ba3
commit 85ddabd763

View File

@@ -2455,7 +2455,7 @@
* @private * @private
* @param {Object} object The destination object. * @param {Object} object The destination object.
* @param {Object} source The source object. * @param {Object} source The source object.
* @param {Function} [customizer] The function to customize merging properties. * @param {Function} [customizer] The function to customize merged values.
* @param {Array} [stackA=[]] Tracks traversed source objects. * @param {Array} [stackA=[]] Tracks traversed source objects.
* @param {Array} [stackB=[]] Associates values with source counterparts. * @param {Array} [stackB=[]] Associates values with source counterparts.
* @returns {Object} Returns `object`. * @returns {Object} Returns `object`.
@@ -2504,7 +2504,7 @@
* @param {Object} source The source object. * @param {Object} source The source object.
* @param {string} key The key of the value to merge. * @param {string} key The key of the value to merge.
* @param {Function} mergeFunc The function to merge values. * @param {Function} mergeFunc The function to merge values.
* @param {Function} [customizer] The function to customize merging properties. * @param {Function} [customizer] The function to customize merged values.
* @param {Array} [stackA=[]] Tracks traversed source objects. * @param {Array} [stackA=[]] Tracks traversed source objects.
* @param {Array} [stackB=[]] Associates values with source counterparts. * @param {Array} [stackB=[]] Associates values with source counterparts.
* @returns {boolean} Returns `true` if the objects are equivalent, else `false`. * @returns {boolean} Returns `true` if the objects are equivalent, else `false`.
@@ -3075,12 +3075,7 @@
} }
/** /**
* Creates a function that aggregates a collection, creating an accumulator * Creates a `_.countBy`, `_.groupBy`, `_.indexBy`, or `_.partition` function.
* object composed from the results of running each element in the collection
* through an iteratee.
*
* **Note:** This function is used to create `_.countBy`, `_.groupBy`, `_.indexBy`,
* and `_.partition`.
* *
* @private * @private
* @param {Function} setter The function to set keys and values of the accumulator object. * @param {Function} setter The function to set keys and values of the accumulator object.
@@ -3110,10 +3105,7 @@
} }
/** /**
* Creates a function that assigns properties of source object(s) to a given * Creates a `_.assign`, `_.defaults`, or `_.merge` function.
* destination object.
*
* **Note:** This function is used to create `_.assign`, `_.defaults`, and `_.merge`.
* *
* @private * @private
* @param {Function} assigner The function to assign values. * @param {Function} assigner The function to assign values.