From bde60141653a2a6ac88c9ce4a0dbecebd8321f5e Mon Sep 17 00:00:00 2001
From: "jason@long.name" <jason@long.name@d9718cc8-9f43-0410-858b-315f434eb58c>
Date: Wed, 5 Mar 2014 01:58:31 +0000
Subject: [PATCH] docs: document the Tiles class

git-svn-id: https://micropolis.googlecode.com/svn/trunk/micropolis-java@919 d9718cc8-9f43-0410-858b-315f434eb58c
---
 src/micropolisj/engine/Tiles.java | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/micropolisj/engine/Tiles.java b/src/micropolisj/engine/Tiles.java
index 5d607ea..f8d6f24 100644
--- a/src/micropolisj/engine/Tiles.java
+++ b/src/micropolisj/engine/Tiles.java
@@ -12,6 +12,9 @@ import java.io.*;
 import java.nio.charset.Charset;
 import java.util.*;
 
+/**
+ * Provides global methods for loading tile specifications.
+ */
 public class Tiles
 {
 	static final Charset UTF8 = Charset.forName("UTF-8");
@@ -76,6 +79,12 @@ public class Tiles
 		}
 	}
 
+	/**
+	 * Access a tile specification by index number.
+	 *
+	 * @return a tile specification, or null if there is no tile
+	 * with the given number
+	 */
 	public static TileSpec get(int tileNumber)
 	{
 		if (tileNumber >= 0 && tileNumber < tiles.length) {