Clean up comments

This commit is contained in:
James Cole
2023-02-22 18:03:31 +01:00
parent 68f398f97c
commit e6dc881f56
119 changed files with 317 additions and 234 deletions

View File

@@ -61,7 +61,9 @@ class ConfigurationController extends Controller
* https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v1)#/configuration/getConfiguration
*
* @return JsonResponse
* @throws ContainerExceptionInterface
* @throws FireflyException
* @throws NotFoundExceptionInterface
*/
public function index(): JsonResponse
{
@@ -96,7 +98,6 @@ class ConfigurationController extends Controller
* Get all config values.
*
* @return array
* @throws FireflyException
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/
@@ -136,7 +137,9 @@ class ConfigurationController extends Controller
* @param string $configKey
*
* @return JsonResponse
* @throws ContainerExceptionInterface
* @throws FireflyException
* @throws NotFoundExceptionInterface
*/
public function show(string $configKey): JsonResponse
{
@@ -171,7 +174,9 @@ class ConfigurationController extends Controller
* @param string $name
*
* @return JsonResponse
* @throws ContainerExceptionInterface
* @throws FireflyException
* @throws NotFoundExceptionInterface
*/
public function update(UpdateRequest $request, string $name): JsonResponse
{

View File

@@ -32,6 +32,8 @@ use FireflyIII\Models\AccountType;
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
use FireflyIII\Support\Http\Api\ConvertsExchangeRates;
use Illuminate\Http\JsonResponse;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;
/**
* Class AccountController
@@ -62,6 +64,8 @@ class AccountController extends Controller
*
* @param DateRequest $request
* @return JsonResponse
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/
public function dashboard(DateRequest $request): JsonResponse
{

View File

@@ -37,8 +37,6 @@ class ShowController extends Controller
{
/**
* TODO this endpoint is not yet reachable.
* @param Account $account
* @return JsonResponse
*/
public function show(Request $request, Account $account): JsonResponse
{

View File

@@ -57,8 +57,6 @@ class ShowController extends Controller
* This endpoint is documented at:
* TODO add URL
*
* @param DateRequest $request
* @return JsonResponse
*/
public function budgeted(DateRequest $request, Budget $budget): JsonResponse
{
@@ -73,8 +71,6 @@ class ShowController extends Controller
* This endpoint is documented at:
* TODO add URL
*
* @param DateRequest $request
* @return JsonResponse
*/
public function spent(DateRequest $request, Budget $budget): JsonResponse
{

View File

@@ -50,7 +50,6 @@ class ListController extends Controller
/**
* This endpoint is documented at:
* https://api-docs.firefly-iii.org/?urls.primaryName=2.0.0%20(v2)#/budgets/listBudgetLimitByBudget
* @return JsonResponse
*/
public function index(DateRequest $request, Budget $budget): JsonResponse
{