document Transaction::add

meadsteve · Apr 18, 2019 · 2745d91 · 2745d91
1 parent 276b697
commit 2745d91
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/src/StepBuilder.php b/src/StepBuilder.php
@@ -10,7 +10,7 @@ class StepBuilder
 {
 
     /**
-     * @param mixed[] ...$args
+     * @param mixed ...$args
      * @return Step
      */
     public static function build(...$args): Step

diff --git a/src/Transaction.php b/src/Transaction.php
@@ -30,6 +30,17 @@ public function __construct(LoggerInterface $logger = null)
     }
 
 
+    /**
+     * Adds a step to the transaction. With the following args:
+     *
+     *    (Step)                  -> Adds the step to transaction
+     *    (Closure, Closure)      -> Creates a step with the first lambda
+     *                               as the execute and the second as compensate
+     *    (Closure, Closure, str) -> Same as above but named
+     *
+     * @param mixed ...$args
+     * @return Transaction
+     */
     public function add(...$args): Transaction
     {
         $step = StepBuilder::build(...$args);