Various doc cleanup. [ci skip]

This commit is contained in:
John-David Dalton
2014-12-30 18:39:25 -06:00
parent d555241d03
commit 90923c965b

View File

@@ -1495,7 +1495,7 @@
* @private * @private
* @name get * @name get
* @memberOf _.memoize.Cache * @memberOf _.memoize.Cache
* @param {string} key The key of the value to retrieve. * @param {string} key The key of the value to get.
* @returns {*} Returns the cached value. * @returns {*} Returns the cached value.
*/ */
function mapGet(key) { function mapGet(key) {
@@ -2498,7 +2498,7 @@
* The base implementation of `_.property` which does not coerce `key` to a string. * The base implementation of `_.property` which does not coerce `key` to a string.
* *
* @private * @private
* @param {string} key The name of the property to retrieve. * @param {string} key The name of the property to get.
* @returns {Function} Returns the new function. * @returns {Function} Returns the new function.
*/ */
function baseProperty(key) { function baseProperty(key) {
@@ -2920,9 +2920,8 @@
/** /**
* Creates a function that aggregates a collection, creating an accumulator * Creates a function that aggregates a collection, creating an accumulator
* object composed from the results of running each element in the collection * object composed from the results of running each element in the collection
* through `iteratee`. The given setter function sets the keys and values of * through an iteratee. The `setter` sets the keys and values of the accumulator
* the accumulator object. If `initializer` is provided it is used to initialize * object. If `initializer` is provided initializes the accumulator object.
* the accumulator object.
* *
* @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.
@@ -2956,7 +2955,7 @@
* destination object. * destination object.
* *
* @private * @private
* @param {Function} assigner The function to handle assigning values. * @param {Function} assigner The function to assign values.
* @returns {Function} Returns the new assigner function. * @returns {Function} Returns the new assigner function.
*/ */
function createAssigner(assigner) { function createAssigner(assigner) {
@@ -3018,7 +3017,7 @@
* given string. * given string.
* *
* @private * @private
* @param {Function} callback The function invoked to combine each word. * @param {Function} callback The function to combine each word.
* @returns {Function} Returns the new compounder function. * @returns {Function} Returns the new compounder function.
*/ */
function createCompounder(callback) { function createCompounder(callback) {
@@ -3450,8 +3449,8 @@
} }
/** /**
* Retrieves the extremum value of `collection` invoking `iteratee` for each * Gets the extremum value of `collection` invoking `iteratee` for each value
* value in `collection` to generate the criterion by which the value is ranked. * in `collection` to generate the criterion by which the value is ranked.
* The `iteratee` is invoked with three arguments; (value, index, collection). * The `iteratee` is invoked with three arguments; (value, index, collection).
* *
* @private * @private
@@ -6003,11 +6002,11 @@
} }
/** /**
* Retrieves the maximum value of `collection`. If `collection` is empty or * Gets the maximum value of `collection`. If `collection` is empty or falsey
* falsey `-Infinity` is returned. If an iteratee function is provided it is * `-Infinity` is returned. If an iteratee function is provided it is invoked
* invoked for each value in `collection` to generate the criterion by which * for each value in `collection` to generate the criterion by which the value
* the value is ranked. The `iteratee` is bound to `thisArg` and invoked with * is ranked. The `iteratee` is bound to `thisArg` and invoked with three
* three arguments; (value, index, collection). * arguments; (value, index, collection).
* *
* If a property name is provided for `iteratee` the created "_.pluck" style * If a property name is provided for `iteratee` the created "_.pluck" style
* callback returns the property value of the given element. * callback returns the property value of the given element.
@@ -6048,11 +6047,11 @@
var max = createExtremum(arrayMax); var max = createExtremum(arrayMax);
/** /**
* Retrieves the minimum value of `collection`. If `collection` is empty or * Gets the minimum value of `collection`. If `collection` is empty or falsey
* falsey `Infinity` is returned. If an iteratee function is provided it is * `Infinity` is returned. If an iteratee function is provided it is invoked
* invoked for each value in `collection` to generate the criterion by which * for each value in `collection` to generate the criterion by which the value
* the value is ranked. The `iteratee` is bound to `thisArg` and invoked with * is ranked. The `iteratee` is bound to `thisArg` and invoked with three
* three arguments; (value, index, collection). * arguments; (value, index, collection).
* *
* If a property name is provided for `iteratee` the created "_.pluck" style * If a property name is provided for `iteratee` the created "_.pluck" style
* callback returns the property value of the given element. * callback returns the property value of the given element.
@@ -6141,7 +6140,7 @@
}, function() { return [[], []]; }); }, function() { return [[], []]; });
/** /**
* Retrieves the value of a specified property from all elements in `collection`. * Gets the value of a specified property from all elements in `collection`.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -6272,7 +6271,7 @@
} }
/** /**
* Retrieves a random element or `n` random elements from a collection. * Gets a random element or `n` random elements from a collection.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -10217,7 +10216,7 @@
* @static * @static
* @memberOf _ * @memberOf _
* @category Utility * @category Utility
* @param {string} key The name of the property to retrieve. * @param {string} key The name of the property to get.
* @returns {Function} Returns the new function. * @returns {Function} Returns the new function.
* @example * @example
* *