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

@@ -44,11 +44,11 @@ use Illuminate\Support\Collection;
class ShowController extends Controller
{
/** @var BudgetRepositoryInterface */
/** @var BudgetRepositoryInterface The budget repository */
private $repository;
/**
*
* ShowController constructor.
*/
public function __construct()
{
@@ -68,6 +68,8 @@ class ShowController extends Controller
}
/**
* Show transactions without a budget.
*
* @param Request $request
* @param Carbon|null $start
* @param Carbon|null $end
@@ -99,6 +101,8 @@ class ShowController extends Controller
}
/**
* Shows ALL transactions without a budget.
*
* @param Request $request
* @param JournalRepositoryInterface $repository
*
@@ -128,6 +132,8 @@ class ShowController extends Controller
/**
* Show a single budget.
*
* @param Request $request
* @param Budget $budget
*
@@ -156,6 +162,8 @@ class ShowController extends Controller
}
/**
* Show a single budget by a budget limit.
*
* @param Request $request
* @param Budget $budget
* @param BudgetLimit $budgetLimit
@@ -195,6 +203,8 @@ class ShowController extends Controller
}
/**
* Gets all budget limits for a budget.
*
* @param Budget $budget
* @param Carbon $start
* @param Carbon $end
@@ -229,6 +239,8 @@ class ShowController extends Controller
/**
* Gets period overview used for budgets.
*
* @return Collection
*
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)