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

@@ -261,6 +261,7 @@ class AccountRepository implements AccountRepositoryInterface
* @return Account
*
* @throws FireflyException
* @throws JsonException
*/
public function getCashAccount(): Account
{

View File

@@ -123,6 +123,8 @@ class AccountTasker implements AccountTaskerInterface
* @param Collection $accounts
*
* @return array
* @throws FireflyException
* @throws JsonException
*/
public function getExpenseReport(Carbon $start, Carbon $end, Collection $accounts): array
{
@@ -221,6 +223,8 @@ class AccountTasker implements AccountTaskerInterface
* @param Collection $accounts
*
* @return array
* @throws FireflyException
* @throws JsonException
*/
public function getIncomeReport(Carbon $start, Carbon $end, Collection $accounts): array
{

View File

@@ -188,6 +188,7 @@ class BillRepository implements BillRepositoryInterface
*
* @return Bill
* @throws FireflyException
* @throws JsonException
*/
public function store(array $data): Bill
{
@@ -911,6 +912,8 @@ class BillRepository implements BillRepositoryInterface
* @param array $data
*
* @return Bill
* @throws FireflyException
* @throws JsonException
*/
public function update(Bill $bill, array $data): Bill
{

View File

@@ -230,6 +230,8 @@ class BudgetRepository implements BudgetRepositoryInterface
* @param array $data
*
* @return Budget
* @throws FireflyException
* @throws JsonException
*/
public function update(Budget $budget, array $data): Budget
{

View File

@@ -209,10 +209,7 @@ interface BudgetRepositoryInterface
/**
* Used in the v2 API to calculate the amount of money spent in a single budget..
*
* @param Carbon $start
* @param Carbon $end
*
* @return array
*/
public function spentInPeriodForBudget(Budget $budget, Carbon $start, Carbon $end): array;

View File

@@ -42,12 +42,6 @@ trait ModifiesPiggyBanks
{
use CreatesObjectGroups;
/**
* @param PiggyBankRepetition $repetition
* @param string $amount
*
* @return void
*/
public function addAmountToRepetition(PiggyBankRepetition $repetition, string $amount, TransactionJournal $journal): void
{
Log::debug(sprintf('addAmountToRepetition: %s', $amount));
@@ -61,12 +55,6 @@ trait ModifiesPiggyBanks
}
}
/**
* @param PiggyBank $piggyBank
* @param string $amount
*
* @return bool
*/
public function removeAmount(PiggyBank $piggyBank, string $amount, ?TransactionJournal $journal = null): bool
{
$repetition = $this->getRepetition($piggyBank);
@@ -109,6 +97,7 @@ trait ModifiesPiggyBanks
* @param string $amount
*
* @return bool
* @throws \JsonException
*/
public function canAddAmount(PiggyBank $piggyBank, string $amount): bool
{

View File

@@ -45,10 +45,6 @@ interface PiggyBankRepositoryInterface
*/
public function addAmount(PiggyBank $piggyBank, string $amount, ?TransactionJournal $journal = null): bool;
/**
* @param PiggyBankRepetition $repetition
* @param string $amount
*/
public function addAmountToRepetition(PiggyBankRepetition $repetition, string $amount, TransactionJournal $journal): void;
/**

View File

@@ -53,6 +53,8 @@ class OperationsRepository implements OperationsRepositoryInterface
* @param Collection|null $tags
*
* @return array
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/
public function listExpenses(Carbon $start, Carbon $end, ?Collection $accounts = null, ?Collection $tags = null): array
{
@@ -150,6 +152,8 @@ class OperationsRepository implements OperationsRepositoryInterface
* @param Collection|null $tags
*
* @return array
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/
public function listIncome(Carbon $start, Carbon $end, ?Collection $accounts = null, ?Collection $tags = null): array
{

View File

@@ -470,6 +470,7 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
* @return TransactionGroup
* @throws DuplicateTransactionException
* @throws FireflyException
* @throws JsonException
*/
public function store(array $data): TransactionGroup
{
@@ -495,6 +496,7 @@ class TransactionGroupRepository implements TransactionGroupRepositoryInterface
*
* @return TransactionGroup
*
* @throws DuplicateTransactionException
* @throws FireflyException
*/
public function update(TransactionGroup $transactionGroup, array $data): TransactionGroup