chore(documentation): throws tag

Adding in the `@throws` tag for the documentation
gaming-engine · Oct 7, 2021 · ca41e3c · ca41e3c
1 parent cc95c4e
commit ca41e3c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/src/Timezone.php b/src/Timezone.php
@@ -15,6 +15,9 @@ class Timezone
 {
     private DateTimeZone $timezone;
 
+    /**
+     * @throws InvalidTimezoneException
+     */
     public function __construct(string $timezone)
     {
         try {

diff --git a/src/TimezoneList.php b/src/TimezoneList.php
@@ -4,6 +4,7 @@
 
 use ArrayAccess;
 use DateTimeZone;
+use GamingEngine\Timezone\Exceptions\InvalidTimezoneException;
 use GamingEngine\Timezone\Exceptions\TimezoneListReadonlyException;
 use Iterator;
 
@@ -14,7 +15,7 @@ class TimezoneList implements ArrayAccess, Iterator
     /**
      * @var Timezone[]
      */
-    private array $timezones = [];
+    private array $timezones;
 
     /**
      * @param Timezone[] $timezones
@@ -25,11 +26,17 @@ private function __construct(array $timezones)
         $this->timezones = $timezones;
     }
 
+    /**
+     * @throws InvalidTimezoneException
+     */
     public static function all(): TimezoneList
     {
         return static::fromTimezoneGroup(DateTimeZone::ALL);
     }
 
+    /**
+     * @throws InvalidTimezoneException
+     */
     public static function fromTimezoneGroup(int $timezoneGroup): TimezoneList
     {
         $timezones = [];
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,6 +15,9 @@ class Timezone @@
     {
         private DateTimeZone $timezone;
+        /**
+         * @throws InvalidTimezoneException
+         */
         public function __construct(string $timezone)
         {
             try {
@@ Expand Down @@