Add php doc [skip ci]

app/Http/Controllers/BillController.php

@@ -48,9 +48,9 @@ class BillController extends Controller
 {
     /** @var AttachmentHelperInterface Helper for attachments. */
     private $attachments;
-    /** @var BillRepositoryInterface */
+    /** @var BillRepositoryInterface Bill repository */
     private $billRepository;
-    /** @var RuleGroupRepositoryInterface */
+    /** @var RuleGroupRepositoryInterface Rule group repository */
     private $ruleGroupRepos;
 
     /**

app/Http/Controllers/Report/AccountController.php

@@ -35,13 +35,15 @@ class AccountController extends Controller
 {
 
     /**
+     * Show partial overview for account balances.
+     *
      * @param Collection $accounts
      * @param Carbon     $start
      * @param Carbon     $end
      *
      * @return mixed|string
      *
-
+     * @throws \Throwable
      */
     public function general(Collection $accounts, Carbon $start, Carbon $end)
     {

app/Http/Controllers/Report/BalanceController.php

@@ -35,12 +35,14 @@ class BalanceController extends Controller
 {
 
     /**
+     * Show overview of budget balances.
+     *
      * @param Collection $accounts
      * @param Carbon     $start
      * @param Carbon     $end
      *
      * @return mixed|string
-
+     * @throws \Throwable
      */
     public function general(Collection $accounts, Carbon $start, Carbon $end)
     {

app/Http/Controllers/Report/BudgetController.php

@@ -36,12 +36,16 @@ class BudgetController extends Controller
 {
 
     /**
+     * Show partial overview of budgets.
+     *
+     * TODO replace all \Throwable by catch/error and return simple string.
+     *
      * @param Collection $accounts
      * @param Carbon     $start
      * @param Carbon     $end
      *
      * @return mixed|string
-
+     * @throws \Throwable
      */
     public function general(Collection $accounts, Carbon $start, Carbon $end)
     {
@@ -65,12 +69,14 @@ class BudgetController extends Controller
 
 
     /**
+     * Show budget overview for a period.
+     *
      * @param Collection $accounts
      * @param Carbon     $start
      * @param Carbon     $end
      *
      * @return mixed|string
-
+     * @throws \Throwable
      */
     public function period(Collection $accounts, Carbon $start, Carbon $end)
     {

app/Http/Controllers/Report/CategoryController.php

@@ -38,6 +38,8 @@ class CategoryController extends Controller
 {
 
     /**
+     * Show overview of expenses in category.
+     *
      * @param Collection $accounts
      * @param Carbon     $start
      * @param Carbon     $end
@@ -75,6 +77,8 @@ class CategoryController extends Controller
 
 
     /**
+     * Show overview of income in category.
+     *
      * @param Collection $accounts
      *
      * @param Carbon     $start
@@ -112,6 +116,8 @@ class CategoryController extends Controller
 
 
     /**
+     * Show overview of operations.
+     *
      * @param Collection $accounts
      * @param Carbon     $start
      * @param Carbon     $end

app/Http/Controllers/Report/ExpenseController.php

@@ -180,7 +180,7 @@ class ExpenseController extends Controller
 
     /** @noinspection MoreThanThreeArgumentsInspection */
     /**
-     * Overview of spending
+     * Overview of spending.
      *
      * @param Collection $accounts
      * @param Collection $expense
@@ -231,6 +231,8 @@ class ExpenseController extends Controller
 
     /** @noinspection MoreThanThreeArgumentsInspection */
     /**
+     * List of top expenses.
+     *
      * @param Collection $accounts
      * @param Collection $expense
      * @param Carbon     $start
@@ -278,6 +280,8 @@ class ExpenseController extends Controller
     }
     /** @noinspection MoreThanThreeArgumentsInspection */
     /**
+     * List of top income.
+     *
      * @param Collection $accounts
      * @param Collection $expense
      * @param Carbon     $start
@@ -325,6 +329,8 @@ class ExpenseController extends Controller
     }
 
     /**
+     * Combine accounts into a single list.
+     *
      * @param Collection $accounts
      *
      * @return array
@@ -349,6 +355,8 @@ class ExpenseController extends Controller
 
     /** @noinspection MoreThanThreeArgumentsInspection */
     /**
+     * Group by category (earnings).
+     *
      * @param Collection $assets
      * @param Collection $opposing
      * @param Carbon     $start
@@ -414,6 +422,8 @@ class ExpenseController extends Controller
 
     /** @noinspection MoreThanThreeArgumentsInspection */
     /**
+     * Earned in period for accounts.
+     *
      * @param Collection $assets
      * @param Collection $opposing
      * @param Carbon     $start
@@ -457,6 +467,8 @@ class ExpenseController extends Controller
 
     /** @noinspection MoreThanThreeArgumentsInspection */
     /**
+     * Spent by budget.
+     *
      * @param Collection $assets
      * @param Collection $opposing
      * @param Carbon     $start
@@ -521,6 +533,8 @@ class ExpenseController extends Controller
 
     /** @noinspection MoreThanThreeArgumentsInspection */
     /**
+     * Spent by category.
+     *
      * @param Collection $assets
      * @param Collection $opposing
      * @param Carbon     $start
@@ -586,6 +600,8 @@ class ExpenseController extends Controller
 
     /** @noinspection MoreThanThreeArgumentsInspection */
     /**
+     * Spent in a period.
+     *
      * @param Collection $assets
      * @param Collection $opposing
      * @param Carbon     $start

app/Http/Controllers/Report/OperationsController.php

@@ -34,7 +34,7 @@ use Illuminate\Support\Collection;
 class OperationsController extends Controller
 {
 
-    /** @var AccountTaskerInterface */
+    /** @var AccountTaskerInterface Some specific account things. */
     private $tasker;
 
     /**
@@ -56,12 +56,14 @@ class OperationsController extends Controller
 
 
     /**
+     * View of income and expense.
+     *
      * @param Collection $accounts
      * @param Carbon     $start
      * @param Carbon     $end
      *
      * @return mixed|string
-
+     * @throws \Throwable
      */
     public function expenses(Collection $accounts, Carbon $start, Carbon $end)
     {
@@ -83,12 +85,14 @@ class OperationsController extends Controller
     }
 
     /**
+     * View of income.
+     *
      * @param Collection $accounts
      * @param Carbon     $start
      * @param Carbon     $end
      *
      * @return string
-
+     * @throws \Throwable
      */
     public function income(Collection $accounts, Carbon $start, Carbon $end): string
     {
@@ -111,12 +115,14 @@ class OperationsController extends Controller
     }
 
     /**
+     * Overview of income and expense.
+     *
      * @param Collection $accounts
      * @param Carbon     $start
      * @param Carbon     $end
      *
      * @return mixed|string
-
+     * @throws \Throwable
      */
     public function operations(Collection $accounts, Carbon $start, Carbon $end)
     {

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