A whole bunch of PHPDocs

PennyDreadfulMTG · Oct 29, 2023 · f567328 · f567328
1 parent 65ccd87
commit f567328
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/gatherling/api_lib.php b/gatherling/api_lib.php
@@ -447,6 +447,11 @@ function card_catalog()
     return $result;
 }
 
+/**
+ * @param string $id
+ * @return string
+ * @throws Exception
+ */
 function cardname_from_id($id)
 {
     $sql = 'SELECT c.name as name FROM cards c WHERE c.scryfallId = ?';

diff --git a/tests/EventsTest.php b/tests/EventsTest.php
@@ -8,10 +8,17 @@
 use Gatherling\Event;
 use Gatherling\Matchup;
 use Gatherling\Series;
+use PHPUnit\Framework\ExpectationFailedException;
 use PHPUnit\Framework\TestCase;
+use SebastianBergmann\RecursionContext\InvalidArgumentException;
 
 final class EventsTest extends TestCase
 {
+    /**
+     * @return Series
+     * @throws InvalidArgumentException
+     * @throws ExpectationFailedException
+     */
     public function testSeriesCreation()
     {
         if (!Series::exists('Test')) {
@@ -30,6 +37,11 @@ public function testSeriesCreation()
     }
 
     /**
+     * @param Series $series
+     * @return Event
+     * @throws Exception
+     * @throws InvalidArgumentException
+     * @throws ExpectationFailedException
      * @depends testSeriesCreation
      */
     public function testEventCreation($series)
@@ -78,6 +90,11 @@ public function testEventCreation($series)
     }
 
     /**
+     * @param Event $event
+     * @return Event
+     * @throws InvalidArgumentException
+     * @throws ExpectationFailedException
+     * @throws Exception
      * @depends testEventCreation
      */
     public function testRegistration($event)
@@ -113,6 +130,10 @@ public function testRegistration($event)
     }
 
     /**
+     * @param mixed $event
+     * @return Event
+     * @throws InvalidArgumentException
+     * @throws ExpectationFailedException
      * @depends testRegistration
      */
     public function testEventStart($event)
@@ -130,6 +151,10 @@ public function testEventStart($event)
     }
 
     /**
+     * @param mixed $event
+     * @return mixed
+     * @throws InvalidArgumentException
+     * @throws ExpectationFailedException
      * @depends testEventStart
      */
     public function testReporting($event)
@@ -151,6 +176,14 @@ public function testReporting($event)
     }
 }
 
+/**
+ * @param string $player
+ * @param Event $event
+ * @param string $main
+ * @param string $side
+ * @return Deck
+ * @throws Exception
+ */
 function insertDeck($player, $event, $main, $side)
 {
     $deck = new Deck(0);