Update PHP doc everywhere.

This commit is contained in:
James Cole
2018-07-21 08:06:24 +02:00
parent 5ca4f1b181
commit 02f5eddd14
47 changed files with 363 additions and 111 deletions

View File

@@ -50,10 +50,10 @@ use Illuminate\Support\Collection;
class BudgetController extends Controller
{
use DateCalculation;
/** @var GeneratorInterface */
/** @var GeneratorInterface Chart generation methods. */
protected $generator;
/** @var BudgetRepositoryInterface */
/** @var BudgetRepositoryInterface The budget repository */
protected $repository;
/**
@@ -75,6 +75,8 @@ class BudgetController extends Controller
/**
* Shows overview of a single budget.
*
* @param Budget $budget
*
* @return JsonResponse
@@ -123,7 +125,6 @@ class BudgetController extends Controller
/**
* Shows the amount left in a specific budget limit.
*
*
* @param Budget $budget
* @param BudgetLimit $budgetLimit
*
@@ -169,6 +170,8 @@ class BudgetController extends Controller
/**
* Shows how much is spent per asset account.
*
* @param Budget $budget
* @param BudgetLimit|null $budgetLimit
*
@@ -217,6 +220,8 @@ class BudgetController extends Controller
/**
* Shows how much is spent per category.
*
* @param Budget $budget
* @param BudgetLimit|null $budgetLimit
*
@@ -266,6 +271,8 @@ class BudgetController extends Controller
/**
* Shows how much is spent per expense account.
*
* @param Budget $budget
* @param BudgetLimit|null $budgetLimit
*
@@ -370,6 +377,7 @@ class BudgetController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Shows a budget overview chart (spent and budgeted).
*
* @param Budget $budget
* @param Carbon $start
@@ -415,6 +423,8 @@ class BudgetController extends Controller
/**
* Shows a chart for transactions without a budget.
*
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
@@ -451,6 +461,8 @@ class BudgetController extends Controller
}
/**
* Get the account names belonging to a bunch of account ID's.
*
* @param array $accountIds
*
* @return array
@@ -473,6 +485,8 @@ class BudgetController extends Controller
}
/**
* Get the amount of money budgeted in a period.
*
* @param Budget $budget
* @param Carbon $start
* @param Carbon $end
@@ -501,7 +515,9 @@ class BudgetController extends Controller
}
/**
* Small helper function for some of the charts.
* Small helper function for some of the charts. Extracts category names from a bunch of ID's.
*
* TODO this method is duplicated and should be in a trait.
*
* @param array $categoryIds
*
@@ -526,6 +542,7 @@ class BudgetController extends Controller
/** @noinspection MoreThanThreeArgumentsInspection */
/**
* Get the expenses for a budget in a date range.
*
* @param Collection $limits
* @param Budget $budget