Cleanup returns tags. [ci skip]

This commit is contained in:
John-David Dalton
2016-05-02 16:50:10 -07:00
parent ce8a1feb94
commit 71f5264ee1

View File

@@ -883,7 +883,7 @@
* @private
* @param {Object} object The object to query.
* @param {Array} props The property names to get values for.
* @returns {Object} Returns the new array of key-value pairs.
* @returns {Object} Returns the key-value pairs.
*/
function baseToPairs(object, props) {
return arrayMap(props, function(key) {
@@ -896,7 +896,7 @@
*
* @private
* @param {Function} func The function to cap arguments for.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new capped function.
*/
function baseUnary(func) {
return function(value) {
@@ -1088,11 +1088,11 @@
}
/**
* Converts `map` to an array.
* Converts `map` to its key-value pairs.
*
* @private
* @param {Object} map The map to convert.
* @returns {Array} Returns the converted array.
* @returns {Array} Returns the key-value pairs.
*/
function mapToArray(map) {
var index = -1,
@@ -1130,11 +1130,11 @@
}
/**
* Converts `set` to an array.
* Converts `set` to an array of its values.
*
* @private
* @param {Object} set The set to convert.
* @returns {Array} Returns the converted array.
* @returns {Array} Returns the values.
*/
function setToArray(set) {
var index = -1,
@@ -2226,7 +2226,7 @@
* @private
* @param {Object} object The object to iterate over.
* @param {string[]} paths The property paths of elements to pick.
* @returns {Array} Returns the new array of picked elements.
* @returns {Array} Returns the picked elements.
*/
function baseAt(object, paths) {
var index = -1,
@@ -2341,7 +2341,7 @@
*
* @private
* @param {Object} source The object of property predicates to conform to.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new spec function.
*/
function baseConforms(source) {
var props = keys(source),
@@ -2654,7 +2654,7 @@
* @private
* @param {Object} object The object to inspect.
* @param {Array} props The property names to filter.
* @returns {Array} Returns the new array of filtered property names.
* @returns {Array} Returns the function names.
*/
function baseFunctions(object, props) {
return arrayFilter(props, function(key) {
@@ -3087,7 +3087,7 @@
*
* @private
* @param {Object} source The object of property values to match.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new spec function.
*/
function baseMatches(source) {
var matchData = getMatchData(source);
@@ -3105,7 +3105,7 @@
* @private
* @param {string} path The path of the property to get.
* @param {*} srcValue The value to match.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new spec function.
*/
function baseMatchesProperty(path, srcValue) {
if (isKey(path) && isStrictComparable(srcValue)) {
@@ -3320,7 +3320,7 @@
*
* @private
* @param {string} key The key of the property to get.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new accessor function.
*/
function baseProperty(key) {
return function(object) {
@@ -3333,7 +3333,7 @@
*
* @private
* @param {Array|string} path The path of the property to get.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new accessor function.
*/
function basePropertyDeep(path) {
return function(object) {
@@ -3434,7 +3434,7 @@
* @param {number} end The end of the range.
* @param {number} step The value to increment or decrement by.
* @param {boolean} [fromRight] Specify iterating from right to left.
* @returns {Array} Returns the new array of numbers.
* @returns {Array} Returns the range of numbers.
*/
function baseRange(start, end, step, fromRight) {
var index = -1,
@@ -4148,7 +4148,7 @@
* placeholders, and provided arguments into a single array of arguments.
*
* @private
* @param {Array|Object} args The provided arguments.
* @param {Array} args The provided arguments.
* @param {Array} partials The arguments to prepend to those provided.
* @param {Array} holders The `partials` placeholder indexes.
* @params {boolean} [isCurried] Specify composing for a curried function.
@@ -4183,7 +4183,7 @@
* is tailored for `_.partialRight`.
*
* @private
* @param {Array|Object} args The provided arguments.
* @param {Array} args The provided arguments.
* @param {Array} partials The arguments to append to those provided.
* @param {Array} holders The `partials` placeholder indexes.
* @params {boolean} [isCurried] Specify composing for a curried function.
@@ -4404,7 +4404,7 @@
*
* @private
* @param {string} methodName The name of the `String` case method to use.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new case function.
*/
function createCaseFirst(methodName) {
return function(string) {
@@ -4700,7 +4700,7 @@
*
* @private
* @param {Function} arrayFunc The function to iterate over iteratees.
* @returns {Function} Returns the new invoker function.
* @returns {Function} Returns the new over function.
*/
function createOver(arrayFunc) {
return rest(function(iteratees) {
@@ -5763,7 +5763,7 @@
* @private
* @param {string} key The key of the property to get.
* @param {*} srcValue The value to match.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new spec function.
*/
function matchesStrictComparable(key, srcValue) {
return function(object) {
@@ -6015,7 +6015,7 @@
* @param {Array} array The array to process.
* @param {number} [size=1] The length of each chunk
* @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`.
* @returns {Array} Returns the new array containing chunks.
* @returns {Array} Returns the new array of chunks.
* @example
*
* _.chunk(['a', 'b', 'c', 'd'], 2);
@@ -7707,7 +7707,7 @@
* @memberOf _
* @since 0.1.0
* @category Array
* @param {Array} array The array to filter.
* @param {Array} array The array to inspect.
* @param {...*} [values] The values to exclude.
* @returns {Array} Returns the new array of filtered values.
* @see _.difference, _.xor
@@ -7733,7 +7733,7 @@
* @since 2.4.0
* @category Array
* @param {...Array} [arrays] The arrays to inspect.
* @returns {Array} Returns the new array of values.
* @returns {Array} Returns the new array of filtered values.
* @see _.difference, _.without
* @example
*
@@ -7757,7 +7757,7 @@
* @param {...Array} [arrays] The arrays to inspect.
* @param {Array|Function|Object|string} [iteratee=_.identity]
* The iteratee invoked per element.
* @returns {Array} Returns the new array of values.
* @returns {Array} Returns the new array of filtered values.
* @example
*
* _.xorBy([2.1, 1.2], [4.3, 2.4], Math.floor);
@@ -7786,7 +7786,7 @@
* @category Array
* @param {...Array} [arrays] The arrays to inspect.
* @param {Function} [comparator] The comparator invoked per element.
* @returns {Array} Returns the new array of values.
* @returns {Array} Returns the new array of filtered values.
* @example
*
* var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
@@ -9241,7 +9241,7 @@
* @param {Function} func The function to cap arguments for.
* @param {number} [n=func.length] The arity cap.
* @param- {Object} [guard] Enables use as an iteratee for methods like `_.map`.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new capped function.
* @example
*
* _.map(['6', '8', '10'], _.ary(parseInt, 1));
@@ -9705,7 +9705,7 @@
* @since 4.0.0
* @category Function
* @param {Function} func The function to flip arguments for.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new flipped function.
* @example
*
* var flipped = _.flip(function() {
@@ -9738,7 +9738,7 @@
* @category Function
* @param {Function} func The function to have its output memoized.
* @param {Function} [resolver] The function to resolve the cache key.
* @returns {Function} Returns the new memoizing function.
* @returns {Function} Returns the new memoized function.
* @example
*
* var object = { 'a': 1, 'b': 2 };
@@ -9796,7 +9796,7 @@
* @since 3.0.0
* @category Function
* @param {Function} predicate The predicate to negate.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new negated function.
* @example
*
* function isEven(n) {
@@ -10159,7 +10159,7 @@
* @since 4.0.0
* @category Function
* @param {Function} func The function to cap arguments for.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new capped function.
* @example
*
* _.map(['6', '8', '10'], _.unary(parseInt));
@@ -11919,7 +11919,7 @@
* @category Object
* @param {Object} object The object to iterate over.
* @param {...(string|string[])} [paths] The property paths of elements to pick.
* @returns {Array} Returns the new array of picked elements.
* @returns {Array} Returns the picked values.
* @example
*
* var object = { 'a': [{ 'b': { 'c': 3 } }, 4] };
@@ -12241,7 +12241,7 @@
* @memberOf _
* @category Object
* @param {Object} object The object to inspect.
* @returns {Array} Returns the new array of property names.
* @returns {Array} Returns the function names.
* @see _.functionsIn
* @example
*
@@ -12268,7 +12268,7 @@
* @since 4.0.0
* @category Object
* @param {Object} object The object to inspect.
* @returns {Array} Returns the new array of property names.
* @returns {Array} Returns the function names.
* @see _.functions
* @example
*
@@ -12915,7 +12915,7 @@
* @alias entries
* @category Object
* @param {Object} object The object to query.
* @returns {Array} Returns the new array of key-value pairs.
* @returns {Array} Returns the key-value pairs.
* @example
*
* function Foo() {
@@ -12941,7 +12941,7 @@
* @alias entriesIn
* @category Object
* @param {Object} object The object to query.
* @returns {Array} Returns the new array of key-value pairs.
* @returns {Array} Returns the key-value pairs.
* @example
*
* function Foo() {
@@ -13784,7 +13784,7 @@
* @param {string} [string=''] The string to split.
* @param {RegExp|string} separator The separator pattern to split by.
* @param {number} [limit] The length to truncate results to.
* @returns {Array} Returns the new array of string segments.
* @returns {Array} Returns the string segments.
* @example
*
* _.split('a-b-c', '-', 2);
@@ -14498,7 +14498,7 @@
* @since 4.0.0
* @category Util
* @param {Array} pairs The predicate-function pairs.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new composite function.
* @example
*
* var func = _.cond([
@@ -14548,7 +14548,7 @@
* @since 4.0.0
* @category Util
* @param {Object} source The object of property predicates to conform to.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new spec function.
* @example
*
* var users = [
@@ -14571,7 +14571,7 @@
* @since 2.4.0
* @category Util
* @param {*} value The value to return from the new function.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new constant function.
* @example
*
* var object = { 'user': 'fred' };
@@ -14596,7 +14596,7 @@
* @since 3.0.0
* @category Util
* @param {...(Function|Function[])} [funcs] Functions to invoke.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new composite function.
* @see _.flowRight
* @example
*
@@ -14619,7 +14619,7 @@
* @memberOf _
* @category Util
* @param {...(Function|Function[])} [funcs] Functions to invoke.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new composite function.
* @see _.flow
* @example
*
@@ -14712,7 +14712,7 @@
* @since 3.0.0
* @category Util
* @param {Object} source The object of property values to match.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new spec function.
* @example
*
* var users = [
@@ -14740,7 +14740,7 @@
* @category Util
* @param {Array|string} path The path of the property to get.
* @param {*} srcValue The value to match.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new spec function.
* @example
*
* var users = [
@@ -14765,7 +14765,7 @@
* @category Util
* @param {Array|string} path The path of the method to invoke.
* @param {...*} [args] The arguments to invoke the method with.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new invoker function.
* @example
*
* var objects = [
@@ -14796,7 +14796,7 @@
* @category Util
* @param {Object} object The object to query.
* @param {...*} [args] The arguments to invoke the method with.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new invoker function.
* @example
*
* var array = _.times(3, _.constant),
@@ -14934,7 +14934,7 @@
* @since 4.0.0
* @category Util
* @param {number} [n=0] The index of the argument to return.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new pass-thru function.
* @example
*
* var func = _.nthArg(1);
@@ -15032,7 +15032,7 @@
* @since 2.4.0
* @category Util
* @param {Array|string} path The path of the property to get.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new accessor function.
* @example
*
* var objects = [
@@ -15059,7 +15059,7 @@
* @since 3.0.0
* @category Util
* @param {Object} object The object to query.
* @returns {Function} Returns the new function.
* @returns {Function} Returns the new accessor function.
* @example
*
* var array = [0, 1, 2],
@@ -15093,7 +15093,7 @@
* @param {number} [start=0] The start of the range.
* @param {number} end The end of the range.
* @param {number} [step=1] The value to increment or decrement by.
* @returns {Array} Returns the new array of numbers.
* @returns {Array} Returns the range of numbers.
* @see _.inRange, _.rangeRight
* @example
*
@@ -15131,7 +15131,7 @@
* @param {number} [start=0] The start of the range.
* @param {number} end The end of the range.
* @param {number} [step=1] The value to increment or decrement by.
* @returns {Array} Returns the new array of numbers.
* @returns {Array} Returns the range of numbers.
* @see _.inRange, _.range
* @example
*