Skip to content

Commit

Permalink
small docblock fixes (#31633)
Browse files Browse the repository at this point in the history
  • Loading branch information
nguyenyou authored Feb 28, 2020
1 parent 0d16818 commit 005cad6
Show file tree
Hide file tree
Showing 17 changed files with 46 additions and 46 deletions.
2 changes: 1 addition & 1 deletion src/Illuminate/Contracts/Queue/Queue.php
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ public function bulk($jobs, $data = '', $queue = null);
/**
* Pop the next job off of the queue.
*
* @param string $queue
* @param string|null $queue
* @return \Illuminate\Contracts\Queue\Job|null
*/
public function pop($queue = null);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@ public function belongsToMany($related, $table = null, $foreignPivotKey = null,
* @param string $relatedPivotKey
* @param string $parentKey
* @param string $relatedKey
* @param string $relationName
* @param string|null $relationName
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
protected function newBelongsToMany(Builder $query, Model $parent, $table, $foreignPivotKey, $relatedPivotKey,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ public function whereHas($relation, Closure $callback = null, $operator = '>=',
* Add a relationship count / exists condition to the query with where clauses and an "or".
*
* @param string $relation
* @param \Closure $callback
* @param \Closure|null $callback
* @param string $operator
* @param int $count
* @return \Illuminate\Database\Eloquent\Builder|static
Expand All @@ -178,7 +178,7 @@ public function whereDoesntHave($relation, Closure $callback = null)
* Add a relationship count / exists condition to the query with where clauses and an "or".
*
* @param string $relation
* @param \Closure $callback
* @param \Closure|null $callback
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public function orWhereDoesntHave($relation, Closure $callback = null)
Expand Down Expand Up @@ -311,7 +311,7 @@ public function whereHasMorph($relation, $types, Closure $callback = null, $oper
*
* @param string $relation
* @param string|array $types
* @param \Closure $callback
* @param \Closure|null $callback
* @param string $operator
* @param int $count
* @return \Illuminate\Database\Eloquent\Builder|static
Expand Down Expand Up @@ -339,7 +339,7 @@ public function whereDoesntHaveMorph($relation, $types, Closure $callback = null
*
* @param string $relation
* @param string|array $types
* @param \Closure $callback
* @param \Closure|null $callback
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public function orWhereDoesntHaveMorph($relation, $types, Closure $callback = null)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ class BelongsToMany extends Relation
* @param string $relatedPivotKey
* @param string $parentKey
* @param string $relatedKey
* @param string $relationName
* @param string|null $relationName
* @return void
*/
public function __construct(Builder $query, Model $parent, $table, $foreignPivotKey,
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Database/Eloquent/Relations/Relation.php
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ public function getRelationExistenceQuery(Builder $query, Builder $parentQuery,
* Get all of the primary keys for an array of models.
*
* @param array $models
* @param string $key
* @param string|null $key
* @return array
*/
protected function getKeys(array $models, $key = null)
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Redis/Connections/PhpRedisConnection.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class PhpRedisConnection extends Connection implements ConnectionContract
* Create a new PhpRedis connection.
*
* @param \Redis $client
* @param callable $connector
* @param callable|null $connector
* @return void
*/
public function __construct($client, callable $connector = null)
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Support/Arr.php
Original file line number Diff line number Diff line change
Expand Up @@ -503,7 +503,7 @@ public static function random($array, $number = null)
* If no key is given to the method, the entire array will be replaced.
*
* @param array $array
* @param string $key
* @param string|null $key
* @param mixed $value
* @return array
*/
Expand Down
8 changes: 4 additions & 4 deletions src/Illuminate/Support/Collection.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public function __construct($items = [])
* Create a new collection by invoking the callback a given amount of times.
*
* @param int $number
* @param callable $callback
* @param callable|null $callback
* @return static
*/
public static function times($number, callable $callback = null)
Expand Down Expand Up @@ -513,7 +513,7 @@ public function has($key)
* Concatenate values of a given key as a string.
*
* @param string $value
* @param string $glue
* @param string|null $glue
* @return string
*/
public function implode($value, $glue = null)
Expand Down Expand Up @@ -959,7 +959,7 @@ public function shift()
/**
* Shuffle the items in the collection.
*
* @param int $seed
* @param int|null $seed
* @return static
*/
public function shuffle($seed = null)
Expand All @@ -982,7 +982,7 @@ public function skip($count)
* Slice the underlying collection array.
*
* @param int $offset
* @param int $length
* @param int|null $length
* @return static
*/
public function slice($offset, $length = null)
Expand Down
20 changes: 10 additions & 10 deletions src/Illuminate/Support/Enumerable.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public static function make($items = []);
* Create a new instance by invoking the callback a given amount of times.
*
* @param int $number
* @param callable $callback
* @param callable|null $callback
* @return static
*/
public static function times($number, callable $callback = null);
Expand Down Expand Up @@ -248,7 +248,7 @@ public function filter(callable $callback = null);
*
* @param bool $value
* @param callable $callback
* @param callable $default
* @param callable|null $default
* @return static|mixed
*/
public function when($value, callable $callback, callable $default = null);
Expand All @@ -257,7 +257,7 @@ public function when($value, callable $callback, callable $default = null);
* Apply the callback if the collection is empty.
*
* @param callable $callback
* @param callable $default
* @param callable|null $default
* @return static|mixed
*/
public function whenEmpty(callable $callback, callable $default = null);
Expand All @@ -266,7 +266,7 @@ public function whenEmpty(callable $callback, callable $default = null);
* Apply the callback if the collection is not empty.
*
* @param callable $callback
* @param callable $default
* @param callable|null $default
* @return static|mixed
*/
public function whenNotEmpty(callable $callback, callable $default = null);
Expand All @@ -276,7 +276,7 @@ public function whenNotEmpty(callable $callback, callable $default = null);
*
* @param bool $value
* @param callable $callback
* @param callable $default
* @param callable|null $default
* @return static|mixed
*/
public function unless($value, callable $callback, callable $default = null);
Expand All @@ -285,7 +285,7 @@ public function unless($value, callable $callback, callable $default = null);
* Apply the callback unless the collection is empty.
*
* @param callable $callback
* @param callable $default
* @param callable|null $default
* @return static|mixed
*/
public function unlessEmpty(callable $callback, callable $default = null);
Expand All @@ -294,7 +294,7 @@ public function unlessEmpty(callable $callback, callable $default = null);
* Apply the callback unless the collection is not empty.
*
* @param callable $callback
* @param callable $default
* @param callable|null $default
* @return static|mixed
*/
public function unlessNotEmpty(callable $callback, callable $default = null);
Expand Down Expand Up @@ -446,7 +446,7 @@ public function has($key);
* Concatenate values of a given key as a string.
*
* @param string $value
* @param string $glue
* @param string|null $glue
* @return string
*/
public function implode($value, $glue = null);
Expand Down Expand Up @@ -714,7 +714,7 @@ public function search($value, $strict = false);
/**
* Shuffle the items in the collection.
*
* @param int $seed
* @param int|null $seed
* @return static
*/
public function shuffle($seed = null);
Expand All @@ -731,7 +731,7 @@ public function skip($count);
* Get a slice of items from the enumerable.
*
* @param int $offset
* @param int $length
* @param int|null $length
* @return static
*/
public function slice($offset, $length = null);
Expand Down
8 changes: 4 additions & 4 deletions src/Illuminate/Support/LazyCollection.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public static function empty()
* Create a new instance by invoking the callback a given amount of times.
*
* @param int $number
* @param callable $callback
* @param callable|null $callback
* @return static
*/
public static function times($number, callable $callback = null)
Expand Down Expand Up @@ -512,7 +512,7 @@ public function has($key)
* Concatenate values of a given key as a string.
*
* @param string $value
* @param string $glue
* @param string|null $glue
* @return string
*/
public function implode($value, $glue = null)
Expand Down Expand Up @@ -916,7 +916,7 @@ public function search($value, $strict = false)
/**
* Shuffle the items in the collection.
*
* @param int $seed
* @param int|null $seed
* @return static
*/
public function shuffle($seed = null)
Expand Down Expand Up @@ -951,7 +951,7 @@ public function skip($count)
* Get a slice of items from the enumerable.
*
* @param int $offset
* @param int $length
* @param int|null $length
* @return static
*/
public function slice($offset, $length = null)
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Support/Manager.php
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ abstract public function getDefaultDriver();
/**
* Get a driver instance.
*
* @param string $driver
* @param string|null $driver
* @return mixed
*
* @throws \InvalidArgumentException
Expand Down
8 changes: 4 additions & 4 deletions src/Illuminate/Support/MessageBag.php
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ public function merge($messages)
/**
* Determine if messages exist for all of the given keys.
*
* @param array|string $key
* @param array|string|null $key
* @return bool
*/
public function has($key)
Expand Down Expand Up @@ -167,7 +167,7 @@ public function first($key = null, $format = null)
* Get all of the messages from the message bag for a given key.
*
* @param string $key
* @param string $format
* @param string|null $format
* @return array
*/
public function get($key, $format = null)
Expand Down Expand Up @@ -211,7 +211,7 @@ protected function getMessagesForWildcardKey($key, $format)
/**
* Get all of the messages for every key in the message bag.
*
* @param string $format
* @param string|null $format
* @return array
*/
public function all($format = null)
Expand All @@ -230,7 +230,7 @@ public function all($format = null)
/**
* Get all of the unique messages for every key in the message bag.
*
* @param string $format
* @param string|null $format
* @return array
*/
public function unique($format = null)
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Support/Str.php
Original file line number Diff line number Diff line change
Expand Up @@ -664,7 +664,7 @@ public static function orderedUuid()
/**
* Set the callable that will be used to generate UUIDs.
*
* @param callable $factory
* @param callable|null $factory
* @return void
*/
public static function createUuidsUsing(callable $factory = null)
Expand Down
4 changes: 2 additions & 2 deletions src/Illuminate/Support/Testing/Fakes/MailFake.php
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ public function raw($text, $callback)
*
* @param string|array $view
* @param array $data
* @param \Closure|string $callback
* @param \Closure|string|null $callback
* @return void
*/
public function send($view, array $data = [], $callback = null)
Expand Down Expand Up @@ -352,7 +352,7 @@ public function queue($view, $queue = null)
*
* @param \DateTimeInterface|\DateInterval|int $delay
* @param \Illuminate\Contracts\Mail\Mailable|string|array $view
* @param string $queue
* @param string|null $queue
* @return mixed
*/
public function later($delay, $view, $queue = null)
Expand Down
12 changes: 6 additions & 6 deletions src/Illuminate/Support/Traits/EnumeratesValues.php
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ public function sum($callback = null)
*
* @param bool|mixed $value
* @param callable $callback
* @param callable $default
* @param callable|null $default
* @return static|mixed
*/
public function when($value, callable $callback, callable $default = null)
Expand All @@ -422,7 +422,7 @@ public function when($value, callable $callback, callable $default = null)
* Apply the callback if the collection is empty.
*
* @param callable $callback
* @param callable $default
* @param callable|null $default
* @return static|mixed
*/
public function whenEmpty(callable $callback, callable $default = null)
Expand All @@ -434,7 +434,7 @@ public function whenEmpty(callable $callback, callable $default = null)
* Apply the callback if the collection is not empty.
*
* @param callable $callback
* @param callable $default
* @param callable|null $default
* @return static|mixed
*/
public function whenNotEmpty(callable $callback, callable $default = null)
Expand All @@ -447,7 +447,7 @@ public function whenNotEmpty(callable $callback, callable $default = null)
*
* @param bool $value
* @param callable $callback
* @param callable $default
* @param callable|null $default
* @return static|mixed
*/
public function unless($value, callable $callback, callable $default = null)
Expand All @@ -459,7 +459,7 @@ public function unless($value, callable $callback, callable $default = null)
* Apply the callback unless the collection is empty.
*
* @param callable $callback
* @param callable $default
* @param callable|null $default
* @return static|mixed
*/
public function unlessEmpty(callable $callback, callable $default = null)
Expand All @@ -471,7 +471,7 @@ public function unlessEmpty(callable $callback, callable $default = null)
* Apply the callback unless the collection is not empty.
*
* @param callable $callback
* @param callable $default
* @param callable|null $default
* @return static|mixed
*/
public function unlessNotEmpty(callable $callback, callable $default = null)
Expand Down
Loading

0 comments on commit 005cad6

Please sign in to comment.