From b5257c0e66ef5d9cef82141a548b9829efaf7db6 Mon Sep 17 00:00:00 2001
From: Florian Bosdorff <dev@bosdorff.de>
Date: Sat, 23 Nov 2019 23:09:39 +0100
Subject: [PATCH] add phpdoc for FunctionalTester

---
 tests/_support/FunctionalTester.php | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/tests/_support/FunctionalTester.php b/tests/_support/FunctionalTester.php
index be8aa3392..ea07902b1 100644
--- a/tests/_support/FunctionalTester.php
+++ b/tests/_support/FunctionalTester.php
@@ -29,6 +29,9 @@ class FunctionalTester extends \Codeception\Actor
      * Define custom actions here
      */
 
+    /**
+     * Login as default administrator
+     */
     public function loginAsAdmin(): void
     {
         $I = $this;
@@ -37,6 +40,12 @@ class FunctionalTester extends \Codeception\Actor
         $I->seeAuthentication('admin');
     }
 
+    /**
+     * Go to a specific route and check if admin guard is applied on it
+     *
+     * @param string     $name name of the route
+     * @param array|null $params params the route will be created with
+     */
     public function amOnAdminRoute(string $name, array $params = null): void
     {
         $I = $this;