Clean up comments

2025-10-12 15:35:15 +00:00 · 2023-02-22 18:03:31 +01:00
parent 68f398f97c
commit e6dc881f56
119 changed files with 317 additions and 234 deletions
--- a/app/Console/Commands/Correction/CorrectOpeningBalanceCurrencies.php
+++ b/app/Console/Commands/Correction/CorrectOpeningBalanceCurrencies.php
@@ -94,6 +94,8 @@ class CorrectOpeningBalanceCurrencies extends Command
     * @param  TransactionJournal  $journal
     *
     * @return int
+     * @throws FireflyException
+     * @throws JsonException
     */
    private function correctJournal(TransactionJournal $journal): int
    {
--- a/app/Console/Commands/Correction/FixAccountTypes.php
+++ b/app/Console/Commands/Correction/FixAccountTypes.php
@@ -166,6 +166,7 @@ class FixAccountTypes extends Command
     * @param  Transaction  $dest
     *
     * @throws FireflyException
+     * @throws \JsonException
     */
    private function fixJournal(TransactionJournal $journal, string $type, Transaction $source, Transaction $dest): void
    {
--- a/app/Console/Commands/DecryptDatabase.php
+++ b/app/Console/Commands/DecryptDatabase.php
@@ -90,6 +90,8 @@ class DecryptDatabase extends Command
    /**
     * @param  string  $table
     * @param  array  $fields
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
     */
    private function decryptTable(string $table, array $fields): void
    {
--- a/app/Console/Commands/Tools/Cron.php
+++ b/app/Console/Commands/Tools/Cron.php
@@ -33,6 +33,8 @@ use FireflyIII\Support\Cronjobs\RecurringCronjob;
 use Illuminate\Console\Command;
 use InvalidArgumentException;
 use Log;
+use Psr\Container\ContainerExceptionInterface;
+use Psr\Container\NotFoundExceptionInterface;

 /**
 * Class Cron
@@ -124,7 +126,6 @@ class Cron extends Command
    /**
     * @param  bool  $force
     * @param  Carbon|null  $date
-     * @throws FireflyException
     */
    private function exchangeRatesCronJob(bool $force, ?Carbon $date): void
    {
@@ -152,7 +153,9 @@ class Cron extends Command
     * @param  bool  $force
     * @param  Carbon|null  $date
     *
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    private function recurringCronJob(bool $force, ?Carbon $date): void
    {
@@ -207,6 +210,8 @@ class Cron extends Command
     * @param  bool  $force
     * @param  Carbon|null  $date
     * @throws FireflyException
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
     */
    private function billWarningCronJob(bool $force, ?Carbon $date): void
    {
--- a/app/Console/Commands/Upgrade/AccountCurrencies.php
+++ b/app/Console/Commands/Upgrade/AccountCurrencies.php
@@ -66,7 +66,9 @@ class AccountCurrencies extends Command
     * Each (asset) account must have a reference to a preferred currency. If the account does not have one, it's forced upon the account.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -110,7 +112,6 @@ class AccountCurrencies extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/AppendBudgetLimitPeriods.php
+++ b/app/Console/Commands/Upgrade/AppendBudgetLimitPeriods.php
@@ -50,7 +50,9 @@ class AppendBudgetLimitPeriods extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -73,7 +75,6 @@ class AppendBudgetLimitPeriods extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/BackToJournals.php
+++ b/app/Console/Commands/Upgrade/BackToJournals.php
@@ -58,7 +58,9 @@ class BackToJournals extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -86,6 +88,8 @@ class BackToJournals extends Command

    /**
     * @return bool
+     * @throws ContainerExceptionInterface
+     * @throws NotFoundExceptionInterface
     */
    private function isMigrated(): bool
    {
@@ -96,7 +100,6 @@ class BackToJournals extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/BudgetLimitCurrency.php
+++ b/app/Console/Commands/Upgrade/BudgetLimitCurrency.php
@@ -53,8 +53,9 @@ class BudgetLimitCurrency extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
-     * @throws JsonException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -100,7 +101,6 @@ class BudgetLimitCurrency extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/CCLiabilities.php
+++ b/app/Console/Commands/Upgrade/CCLiabilities.php
@@ -54,7 +54,9 @@ class CCLiabilities extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -97,7 +99,6 @@ class CCLiabilities extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/MigrateAttachments.php
+++ b/app/Console/Commands/Upgrade/MigrateAttachments.php
@@ -54,7 +54,9 @@ class MigrateAttachments extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -106,7 +108,6 @@ class MigrateAttachments extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/MigrateJournalNotes.php
+++ b/app/Console/Commands/Upgrade/MigrateJournalNotes.php
@@ -55,7 +55,9 @@ class MigrateJournalNotes extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -102,7 +104,6 @@ class MigrateJournalNotes extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/MigrateRecurrenceMeta.php
+++ b/app/Console/Commands/Upgrade/MigrateRecurrenceMeta.php
@@ -56,8 +56,10 @@ class MigrateRecurrenceMeta extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
     * @throws JsonException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -86,7 +88,6 @@ class MigrateRecurrenceMeta extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/MigrateRecurrenceType.php
+++ b/app/Console/Commands/Upgrade/MigrateRecurrenceType.php
@@ -55,7 +55,9 @@ class MigrateRecurrenceType extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -78,7 +80,6 @@ class MigrateRecurrenceType extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/MigrateTagLocations.php
+++ b/app/Console/Commands/Upgrade/MigrateTagLocations.php
@@ -54,7 +54,9 @@ class MigrateTagLocations extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -75,7 +77,6 @@ class MigrateTagLocations extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/MigrateToGroups.php
+++ b/app/Console/Commands/Upgrade/MigrateToGroups.php
@@ -72,7 +72,9 @@ class MigrateToGroups extends Command
     * Execute the console command.
     *
     * @return int
-     * @throws Exception
+     * @throws ContainerExceptionInterface
+     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -130,7 +132,6 @@ class MigrateToGroups extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/MigrateToRules.php
+++ b/app/Console/Commands/Upgrade/MigrateToRules.php
@@ -68,7 +68,9 @@ class MigrateToRules extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -121,7 +123,6 @@ class MigrateToRules extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/OtherCurrenciesCorrections.php
+++ b/app/Console/Commands/Upgrade/OtherCurrenciesCorrections.php
@@ -67,7 +67,9 @@ class OtherCurrenciesCorrections extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -110,7 +112,6 @@ class OtherCurrenciesCorrections extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/RenameAccountMeta.php
+++ b/app/Console/Commands/Upgrade/RenameAccountMeta.php
@@ -52,7 +52,9 @@ class RenameAccountMeta extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -100,7 +102,6 @@ class RenameAccountMeta extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/TransactionIdentifier.php
+++ b/app/Console/Commands/Upgrade/TransactionIdentifier.php
@@ -68,7 +68,9 @@ class TransactionIdentifier extends Command
     * think. So each set gets a number (1,2,3) to keep them apart.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -121,7 +123,6 @@ class TransactionIdentifier extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/TransferCurrenciesCorrections.php
+++ b/app/Console/Commands/Upgrade/TransferCurrenciesCorrections.php
@@ -138,7 +138,6 @@ class TransferCurrenciesCorrections extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/UpgradeLiabilities.php
+++ b/app/Console/Commands/Upgrade/UpgradeLiabilities.php
@@ -60,7 +60,9 @@ class UpgradeLiabilities extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -82,7 +84,6 @@ class UpgradeLiabilities extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
--- a/app/Console/Commands/Upgrade/UpgradeLiabilitiesEight.php
+++ b/app/Console/Commands/Upgrade/UpgradeLiabilitiesEight.php
@@ -62,7 +62,9 @@ class UpgradeLiabilitiesEight extends Command
     * Execute the console command.
     *
     * @return int
+     * @throws ContainerExceptionInterface
     * @throws FireflyException
+     * @throws NotFoundExceptionInterface
     */
    public function handle(): int
    {
@@ -83,7 +85,6 @@ class UpgradeLiabilitiesEight extends Command

    /**
     * @return bool
-     * @throws FireflyException
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */