Merge pull request #23 from MltStephane/chore/improve-type

chore: improve phpdoc types

Author: radicalloop

src/Api/EodClient.php

@@ -14,14 +14,14 @@ abstract class EodClient
     /**
      * configuration
      *
-     * @var RadicalLoop\Eod\Config
+     * @var Config
      */
     protected $config;
 
     /**
      * GuzzleHttp client
      *
-     * @var GuzzleHttp\Client
+     * @var GuzzleHttpClient
      */
     protected $client;
 
@@ -56,9 +56,9 @@ public function getApiUri(): string
     /**
      * send request for api
      *
-     * @param  string  $symbol
-     * @param  array  $params
-     * @return string|json
+     * @param string|null $symbol
+     * @param array $params
+     * @return string
      * @throws GuzzleException
      */
     public function get(string|null $symbol, array $params = [])

src/Config.php

@@ -42,7 +42,7 @@ public function getApiToken()
      * set api key
      *
      * @param string $apiToken
-     * @return string
+     * @return void
      */
     public function setApiToken($apiToken)
     {

src/Eod.php

@@ -3,6 +3,7 @@
 namespace RadicalLoop\Eod;
 
 use RadicalLoop\Eod\Api\Calendar;
+use RadicalLoop\Eod\Api\EodClient;
 use RadicalLoop\Eod\Api\Exchange;
 use RadicalLoop\Eod\Api\Stock;
 

src/Traits/Actionable.php

@@ -34,7 +34,7 @@ public function setParams($symbol, $params)
      * make call to api
      *
      * @param string $dataType
-     * @return string|json
+     * @return string
      */
     public function getData($dataType = self::DATA_TYPE_JSON)
     {
@@ -45,7 +45,7 @@ public function getData($dataType = self::DATA_TYPE_JSON)
     /**
      * return json data
      *
-     * @return json
+     * @return string
      */
     public function json()
     {