From cf626bc30cc668919c1846f370d8a39143d2f1ed Mon Sep 17 00:00:00 2001 From: "jason@long.name" Date: Wed, 5 Mar 2014 01:58:38 +0000 Subject: [PATCH] docs: document the CityRect class git-svn-id: https://micropolis.googlecode.com/svn/trunk/micropolis-java@920 d9718cc8-9f43-0410-858b-315f434eb58c --- src/micropolisj/engine/CityRect.java | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/micropolisj/engine/CityRect.java b/src/micropolisj/engine/CityRect.java index 8eb9c94..6e36502 100644 --- a/src/micropolisj/engine/CityRect.java +++ b/src/micropolisj/engine/CityRect.java @@ -8,6 +8,11 @@ package micropolisj.engine; +/** + * Specifies a rectangular area in the city's coordinate space. + * This class is functionally equivalent to Java AWT's Rectangle + * class, but is portable to Java editions that do not contain AWT. + */ public class CityRect { /** The X coordinate of the upper-left corner of the rectangle. */ @@ -16,7 +21,10 @@ public class CityRect /** The Y coordinate of the upper-left corner of the rectangle. */ public int y; + /** The width of the rectangle. */ public int width; + + /** The height of the rectangle. */ public int height; public CityRect()