From 4fe20e253ed817398d7483ec919a4bbbf2827bdf Mon Sep 17 00:00:00 2001 From: "jason@long.name" Date: Wed, 20 Feb 2013 01:36:57 +0000 Subject: [PATCH] javadocs: document the BudgetNumbers class git-svn-id: https://micropolis.googlecode.com/svn/trunk/micropolis-java@565 d9718cc8-9f43-0410-858b-315f434eb58c --- src/micropolisj/engine/BudgetNumbers.java | 4 ++++ src/micropolisj/engine/Micropolis.java | 3 +++ 2 files changed, 7 insertions(+) diff --git a/src/micropolisj/engine/BudgetNumbers.java b/src/micropolisj/engine/BudgetNumbers.java index 4121c2d..30ddc2e 100644 --- a/src/micropolisj/engine/BudgetNumbers.java +++ b/src/micropolisj/engine/BudgetNumbers.java @@ -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; diff --git a/src/micropolisj/engine/Micropolis.java b/src/micropolisj/engine/Micropolis.java index cf2057f..7d6a934 100644 --- a/src/micropolisj/engine/Micropolis.java +++ b/src/micropolisj/engine/Micropolis.java @@ -1753,6 +1753,9 @@ public class Micropolis policeFundEscrow = 0; } + /** + * Calculate the current budget numbers. + */ public BudgetNumbers generateBudget() { BudgetNumbers b = new BudgetNumbers();