Added amLoggedInAs description (#57)

Author: TavoNiievez

Diff for: src/Codeception/Module/Symfony.php

@@ -1215,6 +1215,23 @@ public function dontSeeFormErrors()
         );
     }
 
+    /**
+     * Login with the given user object.
+     * The `$user` object must have a persistent identifier.
+     * If you have more than one firewall or firewall context, you can specify the desired one as a parameter.
+     *
+     * ```php
+     * <?php
+     * $user = $I->grabEntityFromRepository(User::class, [
+     *     'email' => '[email protected]'
+     * ]);
+     * $I->amLoggedInAs($user);
+     * ```
+     *
+     * @param UserInterface $user
+     * @param string $firewallName
+     * @param null $firewallContext
+     */
     public function amLoggedInAs(UserInterface $user, string $firewallName = 'main', $firewallContext = null)
     {
         $session = $this->grabService('session');