Add docblocks to interfaces

Author: lcobucci

src/DebugInfoStrategy.php

@@ -5,6 +5,9 @@
 
 use Throwable;
 
+/**
+ * Defines how the debug information should be extracted from an error/exception
+ */
 interface DebugInfoStrategy
 {
     /**

src/Problem/AuthorizationRequired.php

@@ -5,6 +5,9 @@
 
 use Throwable;
 
+/**
+ * Marker interface to be used in exceptions related to missing auth information (credentials or valid access token)
+ */
 interface AuthorizationRequired extends Throwable
 {
 }

src/Problem/Conflict.php

@@ -5,6 +5,9 @@
 
 use Throwable;
 
+/**
+ * Marker interface to be used in exceptions related to resource conflicts (version mismatch or duplicated data)
+ */
 interface Conflict extends Throwable
 {
 }

src/Problem/Detailed.php

@@ -5,6 +5,11 @@
 
 use Throwable;
 
+/**
+ * Provides extension members to the problem details
+ *
+ * @see https://tools.ietf.org/html/rfc7807#section-3.2
+ */
 interface Detailed extends Throwable
 {
     /**

src/Problem/Forbidden.php

@@ -5,6 +5,9 @@
 
 use Throwable;
 
+/**
+ * Marker interface to be used in exceptions related to forbidden operations (lack of permission)
+ */
 interface Forbidden extends Throwable
 {
 }

src/Problem/InvalidRequest.php

@@ -5,6 +5,9 @@
 
 use Throwable;
 
+/**
+ * Marker interface to be used in exceptions related to malformed requests (syntax issues)
+ */
 interface InvalidRequest extends Throwable
 {
 }

src/Problem/ResourceNoLongerAvailable.php

@@ -5,6 +5,9 @@
 
 use Throwable;
 
+/**
+ * Marker interface to be used in exceptions related to removed resource (removed/archived items)
+ */
 interface ResourceNoLongerAvailable extends Throwable
 {
 }

src/Problem/ResourceNotFound.php

@@ -5,6 +5,9 @@
 
 use Throwable;
 
+/**
+ * Marker interface to be used in exceptions related to non-existing resources
+ */
 interface ResourceNotFound extends Throwable
 {
 }

src/Problem/ServiceUnavailable.php

@@ -5,6 +5,9 @@
 
 use Throwable;
 
+/**
+ * Marker interface to be used in exceptions related to availability issues (maintenance or dependency issues)
+ */
 interface ServiceUnavailable extends Throwable
 {
 }

src/Problem/Titled.php

@@ -5,6 +5,13 @@
 
 use Throwable;
 
+/**
+ * Provides a custom (human-readable) summary of the problem
+ *
+ * The provided title SHOULD NOT vary from occurrence to occurrence.
+ *
+ * @see https://tools.ietf.org/html/rfc7807#section-3.1
+ */
 interface Titled extends Throwable
 {
     public function getTitle(): string;