Skip to content

Commit 2b858ca

Browse files
committed
Improved docs for exceptions
1 parent 65d3e0d commit 2b858ca

4 files changed

+22
-0
lines changed

src/Exception/FormatGuesserRequiredException.php

+6
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@
1111

1212
namespace Distill\Exception;
1313

14+
/**
15+
* Format guesser required exception.
16+
*
17+
* Exception thrown when a class depends on a format guesser (e.g. Chooser) and no
18+
* guesser has been configured.
19+
*/
1420
class FormatGuesserRequiredException extends \Exception implements ExceptionInterface
1521
{
1622
/**

src/Exception/InvalidArgumentException.php

+5
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111

1212
namespace Distill\Exception;
1313

14+
/**
15+
* Invalid argument exception.
16+
*
17+
* Exception thrown when the parameters passed to a method or function are not correct.
18+
*/
1419
class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
1520
{
1621
/**

src/Exception/Method/ExceptionInterface.php

+5
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@
1313

1414
use Distill\Exception\ExceptionInterface as BaseExceptionInterface;
1515

16+
/**
17+
* Exception interface for all exceptions related to the methods.
18+
*
19+
* @api
20+
*/
1621
interface ExceptionInterface extends BaseExceptionInterface
1722
{
1823
}

src/Exception/StrategyRequiredException.php

+6
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@
1111

1212
namespace Distill\Exception;
1313

14+
/**
15+
* Strategy required exception.
16+
*
17+
* Exception thrown when a class depends on a strategy (e.g. Chooser) and no
18+
* strategy has been configured.
19+
*/
1420
class StrategyRequiredException extends \Exception implements ExceptionInterface
1521
{
1622
/**

0 commit comments

Comments
 (0)