📝 Update docstrings

amcintosh · Mar 28, 2024 · 584bdfa · 584bdfa
1 parent bf01124
commit 584bdfa
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 2 deletions.
diff --git a/src/Exception/FreshBooksClientConfigException.php b/src/Exception/FreshBooksClientConfigException.php
@@ -4,6 +4,11 @@
 
 namespace amcintosh\FreshBooks\Exception;
 
+/**
+ * Exception thrown when the SDK has not been configured properly.
+ *
+ * @package amcintosh\FreshBooks\Exception
+ */
 final class FreshBooksClientConfigException extends \Exception
 {
     public function __construct(string $message)

diff --git a/src/Exception/FreshBooksException.php b/src/Exception/FreshBooksException.php
@@ -4,6 +4,11 @@
 
 namespace amcintosh\FreshBooks\Exception;
 
+/**
+ * Exception thrown when the FreshBooks API returns an error.
+ *
+ * @package amcintosh\FreshBooks\Exception
+ */
 final class FreshBooksException extends \Exception
 {
     public ?string $rawResponse;

diff --git a/src/Exception/FreshBooksNotImplementedException.php b/src/Exception/FreshBooksNotImplementedException.php
@@ -4,6 +4,11 @@
 
 namespace amcintosh\FreshBooks\Exception;
 
+/**
+ * Exception thrown when attempting to make an API call that is not supported.
+ *
+ * @package amcintosh\FreshBooks\Exception
+ */
 final class FreshBooksNotImplementedException extends \Exception
 {
     public function __construct(

diff --git a/src/FreshBooksClient.php b/src/FreshBooksClient.php
@@ -44,6 +44,11 @@
 use amcintosh\FreshBooks\Resource\PaymentResource;
 use amcintosh\FreshBooks\Resource\ProjectResource;
 
+/**
+ * SDK Client.
+ *
+ * @package amcintosh\FreshBooks
+ */
 class FreshBooksClient
 {
     protected ClientInterface $httpClient;

diff --git a/src/FreshBooksClientConfig.php b/src/FreshBooksClientConfig.php
@@ -8,6 +8,8 @@
 
 /**
  * Configuration object for FreshBooks API Client
+ *
+ * @package amcintosh\FreshBooks
  */
 class FreshBooksClientConfig
 {

diff --git a/src/Model/Service.php b/src/Model/Service.php
@@ -27,8 +27,8 @@
  *
  * Services automatically get converted to tasks for inclusion on invoices.
  *
- * @link https://www.freshbooks.com/api/project
- * @see <a href="https://www.freshbooks.com/api/services">FreshBooks API - Services</a>
+ * @package amcintosh\FreshBooks\Model
+ * @link https://www.freshbooks.com/api/services
  */
 class Service extends DataTransferObject
 {