Expand documentation for Helper directory.

app/Helpers/Collection/BalanceEntry.php

@@ -29,14 +29,16 @@ use FireflyIII\Models\Account as AccountModel;
  */
 class BalanceEntry
 {
-    /** @var AccountModel */
+    /** @var AccountModel The account. */
     protected $account;
-    /** @var string */
+    /** @var string The amount left. */
     protected $left = '0';
-    /** @var string */
+    /** @var string The amount spent. */
     protected $spent = '0';
 
     /**
+     * Account getter.
+     *
      * @return AccountModel
      */
     public function getAccount(): AccountModel
@@ -45,6 +47,8 @@ class BalanceEntry
     }
 
     /**
+     * Account setter.
+     *
      * @param AccountModel $account
      */
     public function setAccount(AccountModel $account): void
@@ -53,6 +57,8 @@ class BalanceEntry
     }
 
     /**
+     * Get amount left.
+     *
      * @return string
      */
     public function getLeft(): string
@@ -61,6 +67,8 @@ class BalanceEntry
     }
 
     /**
+     * Set amount left.
+     *
      * @param string $left
      */
     public function setLeft(string $left): void
@@ -69,6 +77,8 @@ class BalanceEntry
     }
 
     /**
+     * Get amount spent.
+     *
      * @return string
      */
     public function getSpent(): string
@@ -77,6 +87,8 @@ class BalanceEntry
     }
 
     /**
+     * Set amount spent.
+     *
      * @param string $spent
      */
     public function setSpent(string $spent): void