Add php doc [skip ci]

app/Http/Controllers/Rule/CreateController.php

@@ -43,9 +43,9 @@ use Throwable;
 class CreateController extends Controller
 {
     use RuleManagement;
-    /** @var BillRepositoryInterface */
+    /** @var BillRepositoryInterface Bill repository */
     private $billRepos;
-    /** @var RuleGroupRepositoryInterface */
+    /** @var RuleRepositoryInterface Rule repository */
     private $ruleRepos;
 
     /**
@@ -143,6 +143,8 @@ class CreateController extends Controller
     }
 
     /**
+     * Store the new rule.
+     *
      * @param RuleFormRequest $request
      *
      * @return RedirectResponse|\Illuminate\Routing\Redirector
@@ -178,6 +180,8 @@ class CreateController extends Controller
     }
 
     /**
+     * Get actions based on a bill.
+     *
      * @param Bill $bill
      *
      * @return array

app/Http/Controllers/Rule/DeleteController.php

@@ -34,7 +34,7 @@ use Illuminate\Http\RedirectResponse;
  */
 class DeleteController extends Controller
 {
-    /** @var RuleRepositoryInterface */
+    /** @var RuleRepositoryInterface Rule repository */
     private $ruleRepos;
 
     /**

app/Http/Controllers/Rule/EditController.php

@@ -43,7 +43,7 @@ class EditController extends Controller
 {
     use RuleManagement;
 
-    /** @var RuleRepositoryInterface */
+    /** @var RuleRepositoryInterface Rule repository */
     private $ruleRepos;
 
     /**
@@ -66,6 +66,8 @@ class EditController extends Controller
     }
 
     /**
+     * Edit a rule.
+     *
      * @param Request $request
      * @param Rule    $rule
      *
@@ -119,6 +121,8 @@ class EditController extends Controller
     }
 
     /**
+     * Update the rule.
+     *
      * @param RuleFormRequest $request
      * @param Rule            $rule
      *
@@ -144,10 +148,11 @@ class EditController extends Controller
     }
 
     /**
+     * Get current (from system) rule actions.
+     *
      * @param Rule $rule
      *
      * @return array
-     *
      */
     private function getCurrentActions(Rule $rule): array
     {
@@ -180,6 +185,8 @@ class EditController extends Controller
     }
 
     /**
+     * Get current (from DB) rule triggers.
+     *
      * @param Rule $rule
      *
      * @return array

app/Http/Controllers/Rule/IndexController.php

@@ -38,9 +38,9 @@ use Illuminate\Http\Request;
 class IndexController extends Controller
 {
     use RuleManagement;
-    /** @var RuleGroupRepositoryInterface */
+    /** @var RuleGroupRepositoryInterface Rule group repository */
     private $ruleGroupRepos;
-    /** @var RuleRepositoryInterface */
+    /** @var RuleRepositoryInterface Rule repository. */
     private $ruleRepos;
 
     /**
@@ -62,6 +62,8 @@ class IndexController extends Controller
     }
 
     /**
+     * Move rule down in list.
+     *
      * @param Rule $rule
      *
      * @return RedirectResponse|\Illuminate\Routing\Redirector
@@ -74,6 +76,8 @@ class IndexController extends Controller
     }
 
     /**
+     * Index of all rules and groups.
+     *
      * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
      */
     public function index()
@@ -88,6 +92,8 @@ class IndexController extends Controller
     }
 
     /**
+     * Stop action for reordering of rule actions.
+     *
      * @param Request $request
      * @param Rule    $rule
      *
@@ -104,6 +110,8 @@ class IndexController extends Controller
     }
 
     /**
+     * Stop action for reordering of rule triggers.
+     *
      * @param Request $request
      * @param Rule    $rule
      *
@@ -121,6 +129,8 @@ class IndexController extends Controller
 
 
     /**
+     * Move rule ip.
+     * 
      * @param Rule $rule
      *
      * @return RedirectResponse|\Illuminate\Routing\Redirector