Add class comment to CallbackReader

yokai-php · Mar 11, 2024 · 2c93939 · 2c93939
1 parent d73b4e7
commit 2c93939
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/batch/src/Job/Item/Reader/CallbackReader.php b/src/batch/src/Job/Item/Reader/CallbackReader.php
@@ -6,6 +6,11 @@
 
 use Yokai\Batch\Job\Item\ItemReaderInterface;
 
+/**
+ * An {@see ItemReaderInterface} that read from a {@see Closure} provided at construction.
+ *
+ * Provided {@see Closure} must accept no argument and must return an iterable of read items.
+ */
 final class CallbackReader implements ItemReaderInterface
 {
     public function __construct(