Assorted doc cleanup. [ci skip]

This commit is contained in:
John-David Dalton
2014-10-31 21:35:03 -07:00
parent 9c6ef34270
commit 4fb83fe0a5

View File

@@ -276,7 +276,12 @@
'\u2029': 'u2029' '\u2029': 'u2029'
}; };
/** Used as a reference to the global object */ /**
* Used as a reference to the global object.
*
* The `this` value is used if it is the global object to avoid Greasemonkey's
* restricted `window` object, otherwise the `window` object is used.
*/
var root = (objectTypes[typeof window] && window !== (this && this.window)) ? window : this; var root = (objectTypes[typeof window] && window !== (this && this.window)) ? window : this;
/** Detect free variable `exports` */ /** Detect free variable `exports` */
@@ -576,8 +581,7 @@
} }
/** /**
* Used by `_.max` and `_.min` as the default callback when a given collection * Used by `_.max` and `_.min` as the default callback for string values.
* is a string value.
* *
* @private * @private
* @param {string} string The string to inspect. * @param {string} string The string to inspect.
@@ -1014,31 +1018,30 @@
/*------------------------------------------------------------------------*/ /*------------------------------------------------------------------------*/
/** /**
* Creates a `lodash` object which wraps the given value to enable intuitive * Creates a `lodash` object which wraps `value` to enable intuitive chaining.
* method chaining. * Explicit chaining may be enabled by using `_.chain`. Chaining is supported
* in custom builds as long as the `_#value` method is implicitly or explicitly
* included in the build.
* *
* In addition to Lo-Dash methods, wrappers also have the following `Array` methods: * In addition to Lo-Dash methods, wrappers also have the following `Array` methods:
* `concat`, `join`, `pop`, `push`, `reverse`, `shift`, `slice`, `sort`, `splice`, * `concat`, `join`, `pop`, `push`, `reverse`, `shift`, `slice`, `sort`, `splice`,
* and `unshift` * and `unshift`
* *
* Chaining is supported in custom builds as long as the `value` method is
* implicitly or explicitly included in the build.
*
* The chainable wrapper functions are: * The chainable wrapper functions are:
* `after`, `assign`, `at`, `before`, `bind`, `bindAll`, `bindKey`, `callback`, * `after`, `assign`, `at`, `before`, `bind`, `bindAll`, `bindKey`, `callback`,
* `chain`, `chunk`, `compact`, `concat`, `constant`, `countBy`, `create`, * `chain`, `chunk`, `compact`, `concat`, `constant`, `countBy`, `create`,
* `curry`, `debounce`, `defaults`, `defer`, `delay`, `difference`, `drop`, * `curry`, `debounce`, `defaults`, `defer`, `delay`, `difference`, `drop`,
* `dropRight`, `dropRightWhile`, `dropWhile`, `filter`, `flatten`, `flattenDeep`, * `dropRight`, `dropRightWhile`, `dropWhile`, `filter`, `flatten`,
* `flow`, `flowRight`, `forEach`, `forEachRight`, `forIn`, `forInRight`, * `flattenDeep`, `flow`, `flowRight`, `forEach`, `forEachRight`, `forIn`,
* `forOwn`, `forOwnRight`, `functions`, `groupBy`, `indexBy`, `initial`, * `forInRight`, `forOwn`, `forOwnRight`, `functions`, `groupBy`, `indexBy`,
* `intersection`, `invert`, `invoke`, `keys`, `keysIn`, `map`, `mapValues`, * `initial`, `intersection`, `invert`, `invoke`, `keys`, `keysIn`, `map`,
* `matches`, `memoize`, `merge`, `mixin`, `negate`, `noop`, `omit`, `once`, * `mapValues`, `matches`, `memoize`, `merge`, `mixin`, `negate`, `noop`,
* `pairs`, `partial`, `partialRight`, `partition`, `pick`, `pluck`, `property`, * `omit`, `once`, `pairs`, `partial`, `partialRight`, `partition`, `pick`,
* `pull`, `pullAt`, `push`, `range`, `reject`, `remove`, `rest`, `reverse`, * `pluck`, `property`, `pull`, `pullAt`, `push`, `range`, `reject`, `remove`,
* `shuffle`, `slice`, `sort`, `sortBy`, `splice`, `take`, `takeRight`, * `rest`, `reverse`, `shuffle`, `slice`, `sort`, `sortBy`, `splice`, `take`,
* `takeRightWhile`, `takeWhile`, `tap`, `throttle`, `thru`, `times`, * `takeRight`, `takeRightWhile`, `takeWhile`, `tap`, `throttle`, `thru`,
* `toArray`, `transform`, `union`, `uniq`, `unshift`, `unzip`, `values`, * `times`, `toArray`, `transform`, `union`, `uniq`, `unshift`, `unzip`,
* `valuesIn`, `where`, `without`, `wrap`, `xor`, `zip`, and `zipObject` * `values`, `valuesIn`, `where`, `without`, `wrap`, `xor`, `zip`, and `zipObject`
* *
* The non-chainable wrapper functions are: * The non-chainable wrapper functions are:
* `attempt`, `camelCase`, `capitalize`, `clone`, `cloneDeep`, `contains`, * `attempt`, `camelCase`, `capitalize`, `clone`, `cloneDeep`, `contains`,
@@ -1047,17 +1050,15 @@
* `has`, `identity`, `indexOf`, `isArguments`, `isArray`, `isBoolean`, isDate`, * `has`, `identity`, `indexOf`, `isArguments`, `isArray`, `isBoolean`, isDate`,
* `isElement`, `isEmpty`, `isEqual`, `isError`, `isFinite`, `isFunction`, * `isElement`, `isEmpty`, `isEqual`, `isError`, `isFinite`, `isFunction`,
* `isNative`, `isNaN`, `isNull`, `isNumber`, `isObject`, `isPlainObject`, * `isNative`, `isNaN`, `isNull`, `isNumber`, `isObject`, `isPlainObject`,
* `isRegExp`, `isString`, `isUndefined`, `join`, `kebabCase`, `last`, * `isRegExp`, `isString`, `isUndefined`, `join`, `kebabCase`, `last`, `lastIndexOf`,
* `lastIndexOf`, `max`, `min`, `noConflict`, `now`, `pad`, `padLeft`, * `max`, `min`, `noConflict`, `now`, `pad`, `padLeft`, `padRight`, `parseInt`,
* `padRight`, `parseInt`, `pop`, `random`, `reduce`, `reduceRight`, `repeat`, * `pop`, `random`, `reduce`, `reduceRight`, `repeat`, `result`, `runInContext`,
* `result`, `runInContext`, `shift`, `size`, `snakeCase`, `some`, `sortedIndex`, * `shift`, `size`, `snakeCase`, `some`, `sortedIndex`, `sortedLastIndex`,
* `sortedLastIndex`, `startsWith`, `template`, `trim`, `trimLeft`, `trimRight`, * `startsWith`, `template`, `trim`, `trimLeft`, `trimRight`, `trunc`, `unescape`,
* `trunc`, `unescape`, `uniqueId`, `value`, and `words` * `uniqueId`, `value`, and `words`
* *
* The wrapper function `sample` will return a wrapped value when `n` is * The wrapper function `sample` will return a wrapped value when `n` is provided,
* provided, otherwise it will return an unwrapped value. * otherwise it will return an unwrapped value.
*
* Explicit chaining can be enabled by using the `_.chain` method.
* *
* @name _ * @name _
* @constructor * @constructor
@@ -7904,10 +7905,9 @@
} }
/** /**
* Creates an object composed of the inverted keys and values of the given * Creates an object composed of the inverted keys and values of `object`.
* object. If the given object contains duplicate values, subsequent values * If `object` contains duplicate values, subsequent values overwrite property
* overwrite property assignments of previous values unless `multiValue` * assignments of previous values unless `multiValue` is `true`.
* is `true`.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -8201,7 +8201,7 @@
} }
/** /**
* Creates a two dimensional array of a given object's key-value pairs, * Creates a two dimensional array of the key-value pairs for `object`,
* e.g. `[[key1, value1], [key2, value2]]`. * e.g. `[[key1, value1], [key2, value2]]`.
* *
* @static * @static
@@ -8431,7 +8431,7 @@
} }
/** /**
* Checks if `string` ends with a given target string. * Checks if `string` ends with the given target string.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -8439,8 +8439,7 @@
* @param {string} [string=''] The string to search. * @param {string} [string=''] The string to search.
* @param {string} [target] The string to search for. * @param {string} [target] The string to search for.
* @param {number} [position=string.length] The position to search from. * @param {number} [position=string.length] The position to search from.
* @returns {boolean} Returns `true` if the given string ends with the * @returns {boolean} Returns `true` if `string` ends with `target`, else `false`.
* target string, else `false`.
* @example * @example
* *
* _.endsWith('abc', 'c'); * _.endsWith('abc', 'c');
@@ -8698,7 +8697,7 @@
}); });
/** /**
* Checks if `string` starts with a given target string. * Checks if `string` starts with the given target string.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -8706,8 +8705,7 @@
* @param {string} [string=''] The string to search. * @param {string} [string=''] The string to search.
* @param {string} [target] The string to search for. * @param {string} [target] The string to search for.
* @param {number} [position=0] The position to search from. * @param {number} [position=0] The position to search from.
* @returns {boolean} Returns `true` if the given string starts with the * @returns {boolean} Returns `true` if `string` starts with `target`, else `false`.
* target string, else `false`.
* @example * @example
* *
* _.startsWith('abc', 'a'); * _.startsWith('abc', 'a');