Fix some docblocks

pierredup · pierredup · commit cd517c76d0b1 · 2018-12-10T23:43:45.000+02:00
diff --git a/src/Array/concat.php b/src/Array/concat.php
@@ -27,10 +27,10 @@
  * $array = [1];
  * $other = concat($array, 2, [3], [[4]]);
  *
- * var_dump(other)
+ * var_dump($other)
  * // => [1, 2, 3, [4]]
  *
- * var_dump(array)
+ * var_dump($array)
  * // => [1]
  * </code>
  */
diff --git a/src/Array/flatten.php b/src/Array/flatten.php
@@ -22,9 +22,10 @@
  *
  * @return array the new flattened array.
  * @example
- *
+ * <code>
  * flatten([1, [2, [3, [4]], 5]])
  * // => [1, 2, [3, [4]], 5]
+ * </code>
  */
 function flatten(array $array = null): array
 {
diff --git a/src/Array/initial.php b/src/Array/initial.php
@@ -20,9 +20,10 @@
  *
  * @return array the slice of `array`.
  * @example
- *
+ * <code>
  * initial([1, 2, 3])
  * // => [1, 2]
+ * </code>
  */
 function initial(array $array): array
 {
diff --git a/src/Array/nth.php b/src/Array/nth.php
@@ -22,14 +22,15 @@
  *
  * @return mixed Returns the nth element of `array`.
  * @example
- *
+ * <code>
  * $array = ['a', 'b', 'c', 'd']
  *
  * nth($array, 1)
  * // => 'b'
  *
  * nth($array, -2)
  * // => 'c'
+ * </code>
  */
 function nth(array $array, int $n)
 {
diff --git a/src/Array/pullAllBy.php b/src/Array/pullAllBy.php
@@ -29,12 +29,13 @@
  *
  * @return array `array`.
  * @example
- *
+ * <code>
  * $array = [[ 'x' => 1 ], [ 'x' => 2 ], [ 'x' => 3 ], [ 'x' => 1 ]]
  *
  * pullAllBy($array, [[ 'x' => 1 ], [ 'x' => 3 ]], 'x')
  * var_dump($array)
  * // => [[ 'x' => 2 ]]
+ * </code>
  */
 function pullAllBy(array &$array, array $values, $iteratee): array
 {
diff --git a/src/Array/remove.php b/src/Array/remove.php
@@ -26,7 +26,7 @@
  *
  * @return array the new array of removed elements.
  * @example
- *
+ * <code>
  * $array = [1, 2, 3, 4]
  * $evens = remove($array, function ($n) { return $n % 2 === 0; })
  *
@@ -35,6 +35,7 @@
  *
  * var_dump($evens)
  * // => [2, 4]
+ * </code>
  */
 function remove(array &$array, callable $predicate): array
 {
diff --git a/src/Collection/findLast.php b/src/Collection/findLast.php
@@ -29,7 +29,7 @@
  * <code>
  * findLast([1, 2, 3, 4], function ($n) { return $n % 2 == 1; })
  * // => 3
- * </cdoe>
+ * </code>
  */
 function findLast(iterable $collection, $predicate = null, int $fromIndex = 0)
 {
diff --git a/src/Collection/partition.php b/src/Collection/partition.php
@@ -26,7 +26,7 @@
  *
  * @return array the array of grouped elements.
  * @example
- *
+ * <code>
  * $users = [
  *   ['user' => 'barney',  'age' => 36, 'active' => false],
  *   ['user' => 'fred',    'age' => 40, 'active' => true],
@@ -35,6 +35,7 @@
  *
  * partition($users, function($user) { return $user['active']; })
  * // => objects for [['fred'], ['barney', 'pebbles']]
+ * </code>
  */
 function partition(iterable $collection, $predicate = null): array
 {
diff --git a/src/Collection/reduceRight.php b/src/Collection/reduceRight.php
@@ -32,6 +32,7 @@
  *
  * reduceRight(array, (flattened, other) => flattened.concat(other), [])
  * // => [4, 5, 2, 3, 0, 1]
+ * </code>
  */
 function reduceRight(iterable $collection, $iteratee, $accumulator = null)
 {
diff --git a/src/Collection/sampleSize.php b/src/Collection/sampleSize.php
@@ -22,12 +22,13 @@
  *
  * @return array the random elements.
  * @example
- *
+ * <code>
  * sampleSize([1, 2, 3], 2)
  * // => [3, 1]
  *
  * sampleSize([1, 2, 3], 4)
  * // => [2, 3, 1]
+ * </code>
  */
 function sampleSize(array $array, int $n = 1): array
 {
diff --git a/src/Collection/shuffle.php b/src/Collection/shuffle.php
@@ -20,9 +20,10 @@
  *
  * @return array the new shuffled array.
  * @example
- *
+ * <code>
  * shuffle([1, 2, 3, 4])
  * // => [4, 1, 3, 2]
+ * </code>
  */
 function shuffle(array $array = []): array
 {
diff --git a/src/Collection/size.php b/src/Collection/size.php
@@ -21,7 +21,7 @@
  *
  * @return int Returns the collection size.
  * @example
- *
+ * <code>
  * size([1, 2, 3]);
  * // => 3
  *
@@ -30,6 +30,7 @@
  *
  * size('pebbles');
  * // => 7
+ * </code>
  */
 function size($collection): int
 {
diff --git a/src/Function/bind.php b/src/Function/bind.php
@@ -23,7 +23,7 @@
  *
  * @return callable Returns the new bound function.
  * @example
- *
+ * <code>
  * function greet($greeting, $punctuation) {
  *   return $greeting . ' ' . $this->user . $punctuation;
  * }
@@ -35,6 +35,7 @@
  * $bound = bind('greet', $object, 'hi');
  * $bound('!');
  * // => 'hi fred!'
+ * </code>
  */
 function bind(callable $function, $object, ...$partials): callable
 {
diff --git a/src/Function/bindKey.php b/src/Function/bindKey.php
@@ -26,7 +26,7 @@
  *
  * @return callable Returns the new bound function.
  * @example
- *
+ * <code>
  * $object = new class {
  *     private $user = 'fred';
  *     function greet($greeting, $punctuation) {
@@ -37,6 +37,7 @@
  * $bound = bindKey($object, 'greet', 'hi');
  * $bound('!');
  * // => 'hi fred!'
+ * </code>
  */
 function bindKey($object, string $function, ...$partials): callable
 {
diff --git a/src/Function/delay.php b/src/Function/delay.php
@@ -23,12 +23,12 @@
  *
  * @return int the timer id.
  * @example
- * <pre>
+ * <code>
  * delay(function($text) {
  *   echo $text;
  * }, 1000, 'later');
  * // => Echo 'later' after one second.
- * </pre>
+ * </code>
  */
 function delay(callable $func, int $wait = 1, ...$args): int
 {
diff --git a/src/Function/negate.php b/src/Function/negate.php
@@ -28,6 +28,7 @@
  *
  * filter([1, 2, 3, 4, 5, 6], negate($isEven));
  * // => [1, 3, 5]
+ * </code>
  */
 
 function negate(callable $predicate): callable
diff --git a/src/Function/partial.php b/src/Function/partial.php
@@ -26,14 +26,15 @@
  * @return callable Returns the new partially applied function.
  *
  * @example
- *
+ * <code>
  * function greet($greeting, $name) {
  *   return $greeting . ' ' . $name;
  * }
  *
  * $sayHelloTo = partial('greet', 'hello');
  * $sayHelloTo('fred');
  * // => 'hello fred'
+ * </code>
  */
 function partial(callable $func, ...$partials): callable
 {
diff --git a/src/Function/spread.php b/src/Function/spread.php
@@ -33,13 +33,14 @@
  * @return callable Returns the new function.
  *
  * @example
- *
+ * <code>
  * $say = spread(function($who, $what) {
  *   return $who . ' says ' . $what;
  * });
  *
  * $say(['fred', 'hello']);
  * // => 'fred says hello'
+ * </code>
  */
 function spread(callable $func, ?int $start = null)
 {
diff --git a/src/Function/wrap.php b/src/Function/wrap.php
@@ -30,6 +30,7 @@
  *
  * $p('fred, barney, & pebbles');
  * // => '<p>fred, barney, &amp; pebbles</p>'
+ * </code>
  */
 function wrap($value, callable $wrapper = null): callable
 {
diff --git a/src/Lang/isError.php b/src/Lang/isError.php
@@ -27,6 +27,7 @@
  *
  * isError(\Exception::Class)
  * // => false
+ * </code>
  */
 function isError($value): bool
 {
diff --git a/src/Math/maxBy.php b/src/Math/maxBy.php
@@ -34,6 +34,7 @@
  * // The `property` iteratee shorthand.
  * maxBy($objects, 'n');
  * // => ['n' => 2]
+ * </code>
  */
 function maxBy(?array $array, $iteratee)
 {
diff --git a/src/Number/random.php b/src/Number/random.php
@@ -26,7 +26,7 @@
  * @return int|float Returns the random number.
  *
  * @example
- *
+ * <code>
  * random(0, 5)
  * // => an integer between 0 and 5
  *
@@ -38,6 +38,7 @@
  *
  * random(1.2, 5.2)
  * // => a floating-point number between 1.2 and 5.2
+ * </code>
  */
 function random($lower = null, $upper = null, $floating = null)
 {
diff --git a/src/Object/pick.php b/src/Object/pick.php
@@ -24,11 +24,12 @@
  *
  * @return \stdClass Returns the new object.
  * @example
- *
+ * <code>
  * $object = (object) ['a' => 1, 'b' => '2', 'c' => 3];
  *
  * pick($object, ['a', 'c']);
  * // => (object) ['a' => 1, 'c' => 3]
+ * </code>
  */
 function pick($object, $paths): \stdClass
 {
diff --git a/src/Object/pickBy.php b/src/Object/pickBy.php
@@ -26,11 +26,12 @@
  *
  * @return \stdClass Returns the new object.
  * @example
- *
+ * <code>
  * $object = (object) ['a' => 1, 'b' => 'abc', 'c' => 3];
  *
  * pickBy(object, 'is_numeric');
  * // => (object) ['a' => 1, 'c' => 3]
+ * </code>
  */
 function pickBy($object, callable $predicate): \stdClass
 {
diff --git a/src/String/deburr.php b/src/String/deburr.php
@@ -96,9 +96,10 @@
  * @return string Returns the deburred string.
  *
  * @example
- *
+ * <code>
  * deburr('déjà vu')
  * // => 'deja vu'
+ * </code>
  */
 function deburr(string $string): string
 {
diff --git a/src/String/snakeCase.php b/src/String/snakeCase.php
@@ -19,7 +19,7 @@
  * @param string $string The string to convert.
  * @return string Returns the snake cased string.
  * @example
- *
+ * <code>
  * snakeCase('Foo Bar')
  * // => 'foo_bar'
  *
@@ -28,6 +28,7 @@
  *
  * snakeCase('--FOO-BAR--')
  * // => 'foo_bar'
+ * </code>
  */
 function snakeCase(string $string): string
 {
diff --git a/src/String/toUpper.php b/src/String/toUpper.php
@@ -29,6 +29,7 @@
  *
  * toUpper('__foo_bar__')
  * // => '__FOO_BAR__'
+ * </code>
  */
 function toUpper(string $string): string
 {
diff --git a/src/String/trimEnd.php b/src/String/trimEnd.php
@@ -21,12 +21,13 @@
  *
  * @return string Returns the trimmed string.
  * @example
- *
+ * <code>
  * trimEnd('  abc  ')
  * // => '  abc'
  *
  * trimEnd('-_-abc-_-', '_-')
  * // => '-_-abc'
+ * </code>
  */
 function trimEnd(string $string, string $chars = ' '): string
 {

Original file line number	Diff line number	Diff line change
`@@ -27,10 +27,10 @@`
`27`	`27`	`* $array = [1];`
`28`	`28`	`* $other = concat($array, 2, [3], [[4]]);`
`29`	`29`	`*`
`30`		`- * var_dump(other)`
	`30`	`+ * var_dump($other)`
`31`	`31`	`* // => [1, 2, 3, [4]]`
`32`	`32`	`*`
`33`		`- * var_dump(array)`
	`33`	`+ * var_dump($array)`
`34`	`34`	`* // => [1]`
`35`	`35`	`* </code>`
`36`	`36`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -22,9 +22,10 @@`
`22`	`22`	`*`
`23`	`23`	`* @return array the new flattened array.`
`24`	`24`	`* @example`
`25`		`- *`
	`25`	`+ * <code>`
`26`	`26`	`* flatten([1, [2, [3, [4]], 5]])`
`27`	`27`	`* // => [1, 2, [3, [4]], 5]`
	`28`	`+ * </code>`
`28`	`29`	`*/`
`29`	`30`	`function flatten(array $array = null): array`
`30`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,10 @@`
`20`	`20`	`*`
`21`	`21`	* @return array the slice of `array`.
`22`	`22`	`* @example`
`23`		`- *`
	`23`	`+ * <code>`
`24`	`24`	`* initial([1, 2, 3])`
`25`	`25`	`* // => [1, 2]`
	`26`	`+ * </code>`
`26`	`27`	`*/`
`27`	`28`	`function initial(array $array): array`
`28`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,14 +22,15 @@`
`22`	`22`	`*`
`23`	`23`	* @return mixed Returns the nth element of `array`.
`24`	`24`	`* @example`
`25`		`- *`
	`25`	`+ * <code>`
`26`	`26`	`* $array = ['a', 'b', 'c', 'd']`
`27`	`27`	`*`
`28`	`28`	`* nth($array, 1)`
`29`	`29`	`* // => 'b'`
`30`	`30`	`*`
`31`	`31`	`* nth($array, -2)`
`32`	`32`	`* // => 'c'`
	`33`	`+ * </code>`
`33`	`34`	`*/`
`34`	`35`	`function nth(array $array, int $n)`
`35`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -29,12 +29,13 @@`
`29`	`29`	`*`
`30`	`30`	* @return array `array`.
`31`	`31`	`* @example`
`32`		`- *`
	`32`	`+ * <code>`
`33`	`33`	`* $array = [[ 'x' => 1 ], [ 'x' => 2 ], [ 'x' => 3 ], [ 'x' => 1 ]]`
`34`	`34`	`*`
`35`	`35`	`* pullAllBy($array, [[ 'x' => 1 ], [ 'x' => 3 ]], 'x')`
`36`	`36`	`* var_dump($array)`
`37`	`37`	`* // => [[ 'x' => 2 ]]`
	`38`	`+ * </code>`
`38`	`39`	`*/`
`39`	`40`	`function pullAllBy(array &$array, array $values, $iteratee): array`
`40`	`41`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`*`
`27`	`27`	`* @return array the new array of removed elements.`
`28`	`28`	`* @example`
`29`		`- *`
	`29`	`+ * <code>`
`30`	`30`	`* $array = [1, 2, 3, 4]`
`31`	`31`	`* $evens = remove($array, function ($n) { return $n % 2 === 0; })`
`32`	`32`	`*`
`@@ -35,6 +35,7 @@`
`35`	`35`	`*`
`36`	`36`	`* var_dump($evens)`
`37`	`37`	`* // => [2, 4]`
	`38`	`+ * </code>`
`38`	`39`	`*/`
`39`	`40`	`function remove(array &$array, callable $predicate): array`
`40`	`41`	`{`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`* <code>`
`30`	`30`	`* findLast([1, 2, 3, 4], function ($n) { return $n % 2 == 1; })`
`31`	`31`	`* // => 3`
`32`		`- * </cdoe>`
	`32`	`+ * </code>`
`33`	`33`	`*/`
`34`	`34`	`function findLast(iterable $collection, $predicate = null, int $fromIndex = 0)`
`35`	`35`	`{`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@`
`32`	`32`	`*`
`33`	`33`	`* reduceRight(array, (flattened, other) => flattened.concat(other), [])`
`34`	`34`	`* // => [4, 5, 2, 3, 0, 1]`
	`35`	`+ * </code>`
`35`	`36`	`*/`
`36`	`37`	`function reduceRight(iterable $collection, $iteratee, $accumulator = null)`
`37`	`38`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,12 +22,13 @@`
`22`	`22`	`*`
`23`	`23`	`* @return array the random elements.`
`24`	`24`	`* @example`
`25`		`- *`
	`25`	`+ * <code>`
`26`	`26`	`* sampleSize([1, 2, 3], 2)`
`27`	`27`	`* // => [3, 1]`
`28`	`28`	`*`
`29`	`29`	`* sampleSize([1, 2, 3], 4)`
`30`	`30`	`* // => [2, 3, 1]`
	`31`	`+ * </code>`
`31`	`32`	`*/`
`32`	`33`	`function sampleSize(array $array, int $n = 1): array`
`33`	`34`	`{`