Merge pull request #7068 from firefly-iii/cleanup-comments

Cleanup comments
This commit is contained in:
James Cole
2023-02-22 18:16:02 +01:00
committed by GitHub
321 changed files with 949 additions and 1263 deletions

View File

@@ -27,6 +27,8 @@ use Carbon\Carbon;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Support\Cronjobs\AutoBudgetCronjob;
use FireflyIII\Support\Cronjobs\RecurringCronjob;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;
/**
* Trait CronRunner
@@ -69,6 +71,8 @@ trait CronRunner
* @param Carbon $date
*
* @return array
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/
protected function runRecurring(bool $force, Carbon $date): array
{

View File

@@ -45,6 +45,7 @@ trait ModelInformation
* @param Bill $bill
*
* @return array
* @throws FireflyException
*/
protected function getActionsForBill(Bill $bill): array // get info and augument
{
@@ -69,7 +70,6 @@ trait ModelInformation
}
/**
*
* @return string[]
*
@@ -94,7 +94,6 @@ trait ModelInformation
}
/**
* @return array
*/
protected function getRoles(): array
@@ -113,6 +112,7 @@ trait ModelInformation
* @param Bill $bill
*
* @return array
* @throws FireflyException
*/
protected function getTriggersForBill(Bill $bill): array // get info and augument
{
@@ -164,6 +164,7 @@ trait ModelInformation
* @param TransactionJournal $journal
*
* @return array
* @throws FireflyException
*/
private function getTriggersForJournal(TransactionJournal $journal): array
{

View File

@@ -200,7 +200,6 @@ trait PeriodOverview
* @param array $journals
*
* @return array
*/
private function filterTransferredIn(Account $account, array $journals): array
{
@@ -219,7 +218,6 @@ trait PeriodOverview
* @param array $journals
*
* @return array
*/
private function groupByCurrency(array $journals): array
{

View File

@@ -51,6 +51,7 @@ trait RenderPartialViews
* @param array $attributes
*
* @return string
* @throws FireflyException
*/
protected function budgetEntry(array $attributes): string // generate view for report.
{
@@ -81,6 +82,7 @@ trait RenderPartialViews
* Get options for budget report.
*
* @return string
* @throws FireflyException
*/
protected function budgetReportOptions(): string // render a view
{
@@ -105,6 +107,7 @@ trait RenderPartialViews
* @param array $attributes
*
* @return string
* @throws FireflyException
*/
protected function budgetSpentAmount(array $attributes): string // generate view for report.
{
@@ -137,6 +140,7 @@ trait RenderPartialViews
* @param array $attributes
*
* @return string
* @throws FireflyException
*/
protected function categoryEntry(array $attributes): string // generate view for report.
{
@@ -163,6 +167,7 @@ trait RenderPartialViews
* Get options for category report.
*
* @return string
* @throws FireflyException
*/
protected function categoryReportOptions(): string // render a view
{
@@ -185,6 +190,7 @@ trait RenderPartialViews
* Get options for double report.
*
* @return string
* @throws FireflyException
*/
protected function doubleReportOptions(): string // render a view
{
@@ -229,6 +235,7 @@ trait RenderPartialViews
* @param array $attributes
*
* @return string
* @throws FireflyException
*/
protected function expenseEntry(array $attributes): string // generate view for report.
{
@@ -263,6 +270,7 @@ trait RenderPartialViews
* @param Rule $rule
*
* @return array
* @throws FireflyException
*/
protected function getCurrentActions(Rule $rule): array // get info from object and present.
{
@@ -301,7 +309,7 @@ trait RenderPartialViews
* @param Rule $rule
*
* @return array
*
* @throws FireflyException
*/
protected function getCurrentTriggers(Rule $rule): array // get info from object and present.
{
@@ -357,6 +365,7 @@ trait RenderPartialViews
* @param array $attributes
*
* @return string
* @throws FireflyException
*/
protected function incomeEntry(array $attributes): string // generate view for report.
{
@@ -388,6 +397,7 @@ trait RenderPartialViews
* Get options for default report.
*
* @return string
* @throws FireflyException
*/
protected function noReportOptions(): string // render a view
{
@@ -406,6 +416,7 @@ trait RenderPartialViews
* Get options for tag report.
*
* @return string
* @throws FireflyException
*/
protected function tagReportOptions(): string // render a view
{

View File

@@ -24,7 +24,6 @@ declare(strict_types=1);
namespace FireflyIII\Support\Http\Controllers;
use Carbon\Carbon;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Exceptions\ValidationException;
use FireflyIII\Helpers\Help\HelpInterface;
use FireflyIII\Http\Requests\RuleFormRequest;
@@ -89,7 +88,6 @@ trait RequestInformation
* Returns if user has seen demo.
*
* @return bool
* @throws FireflyException
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/
@@ -220,7 +218,6 @@ trait RequestInformation
* @param array $data
*
* @return ValidatorContract
*/
final protected function validator(array $data): ValidatorContract
{

View File

@@ -40,7 +40,7 @@ trait RuleManagement
* @param Request $request
*
* @return array
* @throws FireflyException
*/
protected function getPreviousActions(Request $request): array
{
@@ -75,7 +75,7 @@ trait RuleManagement
* @param Request $request
*
* @return array
* @throws FireflyException
*/
protected function getPreviousTriggers(Request $request): array
{
@@ -122,6 +122,7 @@ trait RuleManagement
* @param array $submittedOperators
*
* @return array
* @throws FireflyException
*/
protected function parseFromOperators(array $submittedOperators): array
{