Improved docs for exceptions

raulfraile · Dec 22, 2014 · 2b858ca · 2b858ca
1 parent 65d3e0d
commit 2b858ca
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 0 deletions.
diff --git a/src/Exception/FormatGuesserRequiredException.php b/src/Exception/FormatGuesserRequiredException.php
@@ -11,6 +11,12 @@
 
 namespace Distill\Exception;
 
+/**
+ * Format guesser required exception.
+ *
+ * Exception thrown when a class depends on a format guesser (e.g. Chooser) and no
+ * guesser has been configured.
+ */
 class FormatGuesserRequiredException extends \Exception implements ExceptionInterface
 {
     /**

diff --git a/src/Exception/InvalidArgumentException.php b/src/Exception/InvalidArgumentException.php
@@ -11,6 +11,11 @@
 
 namespace Distill\Exception;
 
+/**
+ * Invalid argument exception.
+ *
+ * Exception thrown when the parameters passed to a method or function are not correct.
+ */
 class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
 {
     /**

diff --git a/src/Exception/Method/ExceptionInterface.php b/src/Exception/Method/ExceptionInterface.php
@@ -13,6 +13,11 @@
 
 use Distill\Exception\ExceptionInterface as BaseExceptionInterface;
 
+/**
+ * Exception interface for all exceptions related to the methods.
+ *
+ * @api
+ */
 interface ExceptionInterface extends BaseExceptionInterface
 {
 }
diff --git a/src/Exception/StrategyRequiredException.php b/src/Exception/StrategyRequiredException.php
@@ -11,6 +11,12 @@
 
 namespace Distill\Exception;
 
+/**
+ * Strategy required exception.
+ *
+ * Exception thrown when a class depends on a strategy (e.g. Chooser) and no
+ * strategy has been configured.
+ */
 class StrategyRequiredException extends \Exception implements ExceptionInterface
 {
     /**