javadocs: document the BudgetNumbers class

git-svn-id: https://micropolis.googlecode.com/svn/trunk/micropolis-java@565 d9718cc8-9f43-0410-858b-315f434eb58c
This commit is contained in:
jason@long.name 2013-02-20 01:36:57 +00:00
parent 4b145e0682
commit 4fe20e253e
2 changed files with 7 additions and 0 deletions

View file

@ -8,6 +8,10 @@
package micropolisj.engine;
/**
* The information generated by the generateBudget function.
* @see micropolisj.engine.Micropolis#generateBudget
*/
public class BudgetNumbers
{
public int taxRate;

View file

@ -1753,6 +1753,9 @@ public class Micropolis
policeFundEscrow = 0;
}
/**
* Calculate the current budget numbers.
*/
public BudgetNumbers generateBudget()
{
BudgetNumbers b = new BudgetNumbers();