Improved PHPDoc

Author: omoikane

src/Client.php

@@ -20,24 +20,30 @@
 /**
  * The Client is the main entry point to access the ActiveCampaign APIs.
  *
- * For create an instance of the Client you need a URL and a KEY. These parameters are specific to
- * your ActiveCampaign account. You can find them under Settings / Developer section of your profile.
+ * To create an instance of the Client, you need a URL and a KEY. These parameters are specific to
+ * your ActiveCampaign account. You can find them under the section Settings / Developer of your profile.
  *
  * @author Daniele De Nobili
  */
 final class Client implements ClientInterface
 {
     /**
+     * ActiveCampaign API base URL
+     *
      * @var string
      */
     private $apiUrl;
 
     /**
+     * API key for authentication
+     *
      * @var string
      */
     private $apiKey;
 
     /**
+     * Guzzle HTTP client for making requests
+     *
      * @var GuzzleClientInterface
      */
     private $guzzleClient;

src/ClientInterface.php

@@ -18,13 +18,31 @@
  */
 interface ClientInterface
 {
+    /**
+     * Performs an HTTP GET request
+     */
     public function get(string $path): Result;
 
+    /**
+     * Performs an HTTP POST request
+     */
     public function post(string $path, array $body): Result;
 
+    /**
+     * Performs an HTTP PUT request
+     */
     public function put(string $path, array $body): Result;
 
+    /**
+     * Performs an HTTP DELETE request
+     */
     public function delete(string $path): Result;
 
+    /**
+     * Tests the validity of API credentials
+     *
+     * Makes a request to the 'users/me' endpoint to verify if
+     * the configured API credentials are valid and working.
+     */
     public function testCredentials(): bool;
 }

src/Result.php

@@ -11,6 +11,15 @@
 
 namespace MetaLine\ActiveCampaign;
 
+/**
+ * Result Container
+ *
+ * Encapsulates the result of an API call, providing access to success status,
+ * response data, and error information. This class is returned by all Client
+ * methods to provide a consistent interface for handling API responses.
+ *
+ * @author Daniele De Nobili
+ */
 final class Result
 {
     /**
@@ -40,15 +49,15 @@ public function __construct(bool $successful = true, array $result = [], array $
     }
 
     /**
-     * Returns true if the client response is successful, false otherwise.
+     * Checks if the API request was successful
      */
     public function isSuccessful(): bool
     {
         return $this->successful;
     }
 
     /**
-     * Returns the data returned from the client call.
+     * Gets the response data from successful API calls
      *
      * If the result is failed, this method returns an empty array.
      */
@@ -58,7 +67,7 @@ public function getData(): array
     }
 
     /**
-     * Returns the errors returned from the client call.
+     * Gets the error information from failed API calls
      *
      * If the result is successful, this method returns an empty array.
      */

tests/Fixture/GenericGuzzleException.php

@@ -14,7 +14,4 @@
 use Exception;
 use GuzzleHttp\Exception\GuzzleException;
 
-/**
- * GenericGuzzleException
- */
 final class GenericGuzzleException extends Exception implements GuzzleException {}