Updated comments.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@230 542714f4-19e9-0310-aa3c-eee0fc999fb1

src/java/com/threerings/media/tile/TileManager.java

@@ -1,5 +1,5 @@
 //
-// $Id: TileManager.java,v 1.12 2001/07/28 01:31:51 shaper Exp $
+// $Id: TileManager.java,v 1.13 2001/08/13 15:00:24 shaper Exp $
 
 package com.threerings.miso.tile;
 
@@ -12,13 +12,18 @@ import java.awt.image.BufferedImage;
 import java.util.ArrayList;
 
 /**
- * Provides a simplified interface for managing multiple tilesets and
- * tiles.
+ * The <code>TileManager</code> class provides a simplified interface
+ * for retrieving and caching tiles.
+ *
+ * @see TileSetManager
  */
 public class TileManager
 {
     /**
-     * Initialize the tile manager with the given TileSetManager object.
+     * Initialize the tile manager with the given
+     * <code>TileSetManager</code> object.
+     *
+     * @param tilesetmgr the tileset manager.
      */
     public TileManager (TileSetManager tilesetmgr)
     {
@@ -26,7 +31,13 @@ public class TileManager
     }
 
     /**
-     * Return the Tile object for the specified tileset and tile id.
+     * Return the <code>Tile</code> object for the specified tileset
+     * and tile id.
+     *
+     * @param tsid the tileset id.
+     * @param tid the tile id.
+     *
+     * @return the tile object.
      */
     public Tile getTile (int tsid, int tid)
     {

src/java/com/threerings/media/tile/TileSetManager.java

@@ -1,5 +1,5 @@
 //
-// $Id: TileSetManager.java,v 1.9 2001/07/23 22:31:48 shaper Exp $
+// $Id: TileSetManager.java,v 1.10 2001/08/13 15:00:24 shaper Exp $
 
 package com.threerings.miso.tile;
 
@@ -9,11 +9,13 @@ import java.awt.Image;
 import java.util.ArrayList;
 
 /**
- * The TileSetManager provides tileset management functionality
- * intended for use by the TileManager.  It provides facilities for
- * obtaining information about individual tilesets, retrieving an list
- * of all tilesets available, and retrieving the image associated with
- * a particular tile in a set.
+ * The <code>TileSetManager</code> provides tileset management
+ * functionality intended for use by the <code>TileManager</code>.  It
+ * provides facilities for obtaining information about individual
+ * tilesets, retrieving an list of all tilesets available, and
+ * retrieving the image associated with a particular tile in a set.
+ *
+ * @see TileManager
  */
 public interface TileSetManager
 {
@@ -27,7 +29,8 @@ public interface TileSetManager
     public int getNumTilesInSet (int tsid);
 
     /**
-     * Return an ArrayList containing all TileSet objects available.
+     * Return an <code>ArrayList</code> containing all
+     * <code>TileSet</code> objects available.
      *
      * @return the list of tilesets.
      */

src/java/com/threerings/media/tile/XMLTileSetParser.java

@@ -1,5 +1,5 @@
 //
-// $Id: XMLTileSetParser.java,v 1.9 2001/08/08 00:33:54 shaper Exp $
+// $Id: XMLTileSetParser.java,v 1.10 2001/08/13 15:00:24 shaper Exp $
 
 package com.threerings.miso.tile;
 
@@ -151,7 +151,7 @@ public class XMLTileSetParser extends DefaultHandler
     /** The tilesets constructed thus far. */
     protected ArrayList _tilesets = new ArrayList();
 
-    // temporary storage of tileset object values
+    /** Temporary storage of tileset object values. */
     protected StringBuffer _chars;
     protected String _tsName;
     protected int    _tsTsid;

src/java/com/threerings/media/util/PerformanceMonitor.java

@@ -1,5 +1,5 @@
 //
-// $Id: PerformanceMonitor.java,v 1.1 2001/08/02 00:42:02 shaper Exp $
+// $Id: PerformanceMonitor.java,v 1.2 2001/08/13 15:00:24 shaper Exp $
 
 package com.threerings.miso.util;
 
@@ -24,7 +24,7 @@ import com.threerings.miso.Log;
  * <p> Note that this is <em>not</em> intended to be used as an
  * industrial-strength profiling or performance monitoring tool.  The
  * checkpoint time interval granularity is in milliseconds, not
- * microseconds; and the observer's <code>checkpoint()</code> method
+ * microseconds, and the observer's <code>checkpoint()</code> method
  * will never be called until/unless a subsequent call to
  * <code>tick()</code> is made after the requested number of
  * milliseconds have passed since the last checkpoint.
@@ -117,6 +117,10 @@ public class PerformanceMonitor
     protected static HashMap _observers = new HashMap();
 }
 
+/**
+ * This class represents the individual actions being tracked by the
+ * <code>PerformanceMonitor</code> class.
+ */
 class PerformanceAction
 {
     public PerformanceAction (PerformanceObserver obs, String name, long delta)
@@ -155,9 +159,18 @@ class PerformanceAction
         return buf.append("]").toString();
     }
 
+    /** The performance observer. */
     protected PerformanceObserver _obs;
+
+    /** The action name. */
     protected String _name;
+
+    /** The number of milliseconds between each checkpoint. */
     protected long _delta;
+
+    /** The time the last time a checkpoint was made. */ 
     protected long _lastDelta;
+
+    /** The number of ticks since the last checkpoint. */
     protected int _numTicks;
 }