Chore: Add phpdocs

This commit is contained in:
James Cole
2023-07-04 13:29:19 +02:00
parent 7840e37e1a
commit 775504acb6
121 changed files with 471 additions and 84 deletions

View File

@@ -155,12 +155,13 @@ class ReconcileController extends Controller
* Submit a new reconciliation.
*
* @param ReconciliationStoreRequest $request
* @param Account $account
* @param Carbon $start
* @param Carbon $end
* @param Account $account
* @param Carbon $start
* @param Carbon $end
*
* @return RedirectResponse|Redirector
* @throws DuplicateTransactionException
* @throws JsonException
*/
public function submit(ReconciliationStoreRequest $request, Account $account, Carbon $start, Carbon $end)
{

View File

@@ -63,7 +63,6 @@ class ConfigurationController extends Controller
* Show configuration index.
*
* @return Factory|View
* @throws FireflyException
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/

View File

@@ -58,7 +58,6 @@ class HomeController extends Controller
* Index of the admin.
*
* @return Factory|View
* @throws FireflyException
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/
@@ -83,6 +82,10 @@ class HomeController extends Controller
return view('admin.index', compact('title', 'mainTitleIcon', 'email', 'notifications', 'slackUrl'));
}
/**
* @param Request $request
* @return RedirectResponse
*/
public function notifications(Request $request): RedirectResponse
{
foreach (config('firefly.admin_notifications') as $item) {

View File

@@ -89,7 +89,7 @@ class UserController extends Controller
/**
* @param InvitedUser $invitedUser
* @return RedirectResponse
* @return JsonResponse
*/
public function deleteInvite(InvitedUser $invitedUser): JsonResponse
{

View File

@@ -79,7 +79,6 @@ class NoCategoryController extends Controller
*
* @return Factory|View
* @throws FireflyException
* @throws JsonException
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/
@@ -119,7 +118,6 @@ class NoCategoryController extends Controller
* @param Request $request
*
* @return Factory|View
* @throws FireflyException
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/

View File

@@ -72,7 +72,6 @@ class ReportController extends Controller
* @param Carbon $end
*
* @return JsonResponse
* @throws FireflyException
*/
public function netWorth(Collection $accounts, Carbon $start, Carbon $end): JsonResponse
{

View File

@@ -32,6 +32,8 @@ use FireflyIII\Support\Export\ExportDataGenerator;
use Illuminate\Contracts\View\Factory;
use Illuminate\Http\Response as LaravelResponse;
use Illuminate\View\View;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;
/**
* Class IndexController
@@ -65,6 +67,8 @@ class IndexController extends Controller
/**
* @return LaravelResponse
* @throws FireflyException
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/
public function export(): LaravelResponse
{

View File

@@ -145,9 +145,6 @@ class RecurrenceController extends Controller
* @param Request $request
*
* @return JsonResponse
* @throws FireflyException
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/
public function suggest(Request $request): JsonResponse
{