From dad3294a211554942069236bb5b7a45a43091dbc Mon Sep 17 00:00:00 2001
From: Thomas Landauer <thomas@landauer.at>
Date: Mon, 15 Mar 2021 14:04:51 +0100
Subject: [PATCH] Adding @var annotation for return type

... to better emphasize what you'll get back; especially since `@return \Symfony\Component\Mime\Email|null` isn't rendered right, due to https://github.com/Codeception/Codeception/issues/6104

So I added a docblock within the docblock, so to say ;-)
---
 src/Codeception/Module/Symfony/MailerAssertionsTrait.php | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/Codeception/Module/Symfony/MailerAssertionsTrait.php b/src/Codeception/Module/Symfony/MailerAssertionsTrait.php
index d51769e2..e5f12ac8 100644
--- a/src/Codeception/Module/Symfony/MailerAssertionsTrait.php
+++ b/src/Codeception/Module/Symfony/MailerAssertionsTrait.php
@@ -42,9 +42,10 @@ public function seeEmailIsSent(int $expectedCount = 1): void
      *
      * ```php
      * <?php
+     * /** @var ?\Symfony\Component\Mime\Email $email */
      * $email = $I->grabLastSentEmail();
      * $address = $email->getTo()[0];
-     * $I->assertSame('john_doe@user.com', $address->getAddress());
+     * $I->assertSame('john_doe@example.com', $address->getAddress());
      * ```
      *
      * @return \Symfony\Component\Mime\Email|null
@@ -90,4 +91,4 @@ protected function getMessageMailerEvents(): MessageEvents
 
         $this->fail("Emails can't be tested without Symfony Mailer service.");
     }
-}
\ No newline at end of file
+}