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

@@ -149,12 +149,6 @@ trait ConvertsExchangeRates
return $result;
}
/**
* @param string $amount
* @param TransactionCurrency $from
* @param TransactionCurrency $to
* @return string
*/
private function convertAmount(string $amount, TransactionCurrency $from, TransactionCurrency $to, ?Carbon $date = null): string
{
Log::debug(sprintf('Converting %s from %s to %s', $amount, $from->code, $to->code));

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
{
@@ -113,6 +114,7 @@ trait ModelInformation
* @param Bill $bill
*
* @return array
* @throws FireflyException
*/
protected function getTriggersForBill(Bill $bill): array // get info and augument
{
@@ -164,6 +166,7 @@ trait ModelInformation
* @param TransactionJournal $journal
*
* @return array
* @throws FireflyException
*/
private function getTriggersForJournal(TransactionJournal $journal): 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

@@ -89,7 +89,6 @@ trait RequestInformation
* Returns if user has seen demo.
*
* @return bool
* @throws FireflyException
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
*/

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
{