Use fully-qualified class names in PHPDoc (#7)

* Use fully-qualified class names in PHPDoc
glorand · Dec 20, 2018 · 4855217 · 4855217
1 parent 85d7cc5
commit 4855217
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 All notable changes to `glorand/drip-php` will be documented in this file
 
+## 1.0.4 - 2018-12-20
+### Update
+- Use fully-qualified class names in PHPDoc
+
 ## 1.0.3 - 2018-12-18
 ### Added
 - Batch API

diff --git a/src/Api/Accounts.php b/src/Api/Accounts.php
@@ -9,7 +9,7 @@ class Accounts extends Api
  /**
  * List all accounts.
  *
- * @return Response\ApiResponse
+ * @return \Glorand\Drip\Api\Response\ApiResponse
  */
  public function list(): ApiResponse
  {
@@ -21,7 +21,7 @@ public function list(): ApiResponse
  *
  * @param string $accountId
  *
- * @return ApiResponse
+ * @return \Glorand\Drip\Api\Response\ApiResponse
  */
  public function show(string $accountId): ApiResponse
  {

diff --git a/src/Api/Api.php b/src/Api/Api.php
@@ -24,8 +24,8 @@ abstract class Api
  /**
  * Api constructor.
  *
- * @param Client $client
- * @param string $accountId
+ * @param \GuzzleHttp\Client $client
+ * @param string  $accountId
  */
  public function __construct(Client $client, string $accountId)
  {

diff --git a/src/Api/Events.php b/src/Api/Events.php
@@ -12,9 +12,8 @@ class Events extends Api
  * @param int $page
  * @param int $perPage
  *
- * @throws DripException
- *
- * @return Response\ApiResponse
+ * @return \Glorand\Drip\Api\Response\ApiResponse
+ * @throws \Glorand\Drip\Exceptions\DripException
  */
  public function list(int $page = 1, int $perPage = 100): ApiResponse
  {
@@ -34,8 +33,7 @@ public function list(int $page = 1, int $perPage = 100): ApiResponse
  /**
  * Record an event
  * @see https://developer.drip.com/?shell#events
- *
- * @param Event $event
+ * @param \Glorand\Drip\Models\Event $event
  *
  * @return bool
  */

diff --git a/src/Api/Subscribers.php b/src/Api/Subscribers.php
@@ -16,7 +16,7 @@ class Subscribers extends Api
  * subscribed_before - Optional. A ISO-8601 datetime. Eg. "2017-01-01T00:00:00Z"
  * subscribed_after - Optional. A ISO-8601 datetime. Eg. "2016-01-01T00:00:00Z"
  *
- * @return ApiResponse
+ * @return \Glorand\Drip\Api\Response\ApiResponse;
  */
  public function list(int $page = 1, int $perPage = 100, array $params = []): ApiResponse
  {
@@ -33,7 +33,7 @@ public function list(int $page = 1, int $perPage = 100, array $params = []): Api
  }
 
  /**
- * @param Subscriber $subscriber
+ * @param \Glorand\Drip\Models\Subscriber $subscriber
  *
  * @return bool
  */

diff --git a/src/Drip.php b/src/Drip.php
@@ -25,23 +25,23 @@ public function __construct(string $accountId, string $apiToken, string $userAge
  }
 
  /**
- * @return Events
+ * @return \Glorand\Drip\Api\Events
  */
  public function events(): Events
  {
  return new Events($this->getClient(), $this->accountId);
  }
 
  /**
- * @return Subscribers
+ * @return \Glorand\Drip\Api\Subscribers
  */
  public function subscribers(): Subscribers
  {
  return new Subscribers($this->getClient(), $this->accountId);
  }
 
  /**
- * @return Accounts
+ * @return \Glorand\Drip\Api\Accounts
  */
  public function accounts(): Accounts
  {