docs: document the CityRect class

git-svn-id: https://micropolis.googlecode.com/svn/trunk/micropolis-java@920 d9718cc8-9f43-0410-858b-315f434eb58c
This commit is contained in:
jason@long.name 2014-03-05 01:58:38 +00:00
parent bde6014165
commit cf626bc30c

View file

@ -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()