Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[8.x] fix doc blocks #35675

Merged
merged 2 commits into from
Dec 21, 2020
Merged

[8.x] fix doc blocks #35675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d2d047
fix doc blocks
rodrigopedra Dec 19, 2020
23ad9e3
revert send docblock to mixed
rodrigopedra Dec 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Illuminate/Cache/CacheLock.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class CacheLock extends Lock
/**
* Create a new lock instance.
*
* @var \Illuminate\Contracts\Cache\Store
* @param \Illuminate\Contracts\Cache\Store $store
* @param string $name
* @param int $seconds
* @param string|null $owner
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Mail/Mailer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ protected function setGlobalToAndRemoveCcAndBcc($message)
/**
* Queue a new e-mail message for sending.
*
* @param \Illuminate\Contracts\Mail\Mailable $view
* @param \Illuminate\Contracts\Mail\Mailable|string|array $view
* @param string|null $queue
* @return mixed
*
Expand Down
1 change: 0 additions & 1 deletion src/Illuminate/Mail/PendingMail.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,6 @@ public function bcc($users)
* Send a new mailable message instance.
*
* @param \Illuminate\Contracts\Mail\Mailable $mailable
*
* @return mixed
*/
public function send(MailableContract $mailable)
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Notifications/NotificationSender.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ protected function shouldSendNotification($notifiable, $notification, $channel)
* Queue the given notification instances.
*
* @param mixed $notifiables
* @param array[\Illuminate\Notifications\Channels\Notification] $notification
* @param \Illuminate\Notifications\Notification $notification
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The implementation does not expects an array on this parameter

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @williamdes

Maybe this one you want to take a look on how doctum is handling, the error message was odd for this line:

ERROR: The "r" @param tag variable name is wrong (should be "notification") on "Illuminate\Notifications\NotificationSender::queueNotification" in build/doctum/laravel/src/Illuminate/Notifications/NotificationSender.php:177

As you can see the @param variable was not called r. Maybe it is because it used this odd syntax with brackets

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ha, thanks for pointing this out
I had some chance this time because you looked to the old errors report, please have a look to the "5.3.0-dev" one instead :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now I see, thanks for the heads up

* @return void
*/
protected function queueNotification($notifiables, $notification)
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Support/Testing/Fakes/MailFake.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ public function send($view, array $data = [], $callback = null)
/**
* Queue a new e-mail message for sending.
*
* @param string|array $view
* @param \Illuminate\Contracts\Mail\Mailable|string|array $view
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to match its interface

* @param string|null $queue
* @return mixed
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Illuminate/Support/Testing/Fakes/PendingMailFake.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public function __construct($mailer)
/**
* Send a new mailable message instance.
*
* @param \Illuminate\Contracts\Mail\Mailable $mailable;
* @param \Illuminate\Contracts\Mail\Mailable $mailable
* @return mixed
*/
public function send(Mailable $mailable)
Expand All @@ -32,7 +32,7 @@ public function send(Mailable $mailable)
/**
* Push the given mailable onto the queue.
*
* @param \Illuminate\Contracts\Mail\Mailable $mailable;
* @param \Illuminate\Contracts\Mail\Mailable $mailable
* @return mixed
*/
public function queue(Mailable $mailable)
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Validation/Rules/Dimensions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ class Dimensions
/**
* Create a new dimensions rule instance.
*
* @param array $constraints;
* @param array $constraints
* @return void
*/
public function __construct(array $constraints = [])
Expand Down