Big fat Bernie javadoc cleanup.

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

build.xml

@@ -118,14 +118,18 @@
 
   <!-- build the javadoc documentation -->
   <target name="javadoc" depends="prepare">
-    <javadoc sourcepath="src/java"
+    <javadoc packagenames="com.threerings.*" destdir="${javadoc.home}"
-             packagenames="com.threerings.*"
+             additionalparam="-breakiterator -quiet"
-             destdir="${javadoc.home}"
+             link="http://www.threerings.net/code/narya/narya/docs/api">
-             additionalparam="-breakiterator"
-             link="http://dev.threerings.net/devel/docs/narya/">
       <classpath refid="classpath"/>
       <link href="http://java.sun.com/j2se/1.4/docs/api/"/>
-      <link href="http://dev.threerings.net/devel/docs/samskivert/"/>
+      <link href="http://samskivert.com/code/samskivert/samskivert/docs/api"/>
+      <fileset dir="src/java" includes="**/*.java">
+        <exclude name="**/OggPlayer.java"/>
+        <exclude name="**/ModPlayer.java"/>
+        <exclude name="**/MidiPlayer.java"/>
+        <exclude name="**/Mp3Player.java"/>
+      </fileset>
     </javadoc>
     <copy todir="${javadoc.home}">
       <fileset dir="src/java" includes="**/*.png"/>

src/java/com/threerings/admin/server/ConfObjRegistry.java

@@ -37,6 +37,7 @@ import com.threerings.io.ObjectInputStream;
 import com.threerings.io.ObjectOutputStream;
 import com.threerings.io.Streamable;
 
+import com.threerings.presents.dobj.AccessController;
 import com.threerings.presents.dobj.AttributeChangeListener;
 import com.threerings.presents.dobj.AttributeChangedEvent;
 import com.threerings.presents.dobj.DObject;

src/java/com/threerings/cast/ActionFrames.java

@@ -1,5 +1,5 @@
 //
-// $Id: ActionFrames.java,v 1.11 2004/08/27 02:12:25 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -22,6 +22,7 @@
 package com.threerings.cast;
 
 import com.threerings.media.image.Colorization;
+import com.threerings.util.DirectionCodes;
 
 /**
  * Encapsulates a set of frames in each of {@link

src/java/com/threerings/cast/CharacterComponent.java

@@ -1,5 +1,5 @@
 //
-// $Id: CharacterComponent.java,v 1.10 2004/08/27 02:12:25 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -25,6 +25,8 @@ import java.io.Serializable;
 
 import com.samskivert.util.StringUtil;
 
+import com.threerings.media.sprite.Sprite;
+
 /**
  * The character component represents a single component that can be
  * composited with other character components to generate an image

src/java/com/threerings/cast/CharacterSprite.java

@@ -1,5 +1,5 @@
 //
-// $Id: CharacterSprite.java,v 1.47 2004/08/27 02:12:25 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -24,6 +24,7 @@ package com.threerings.cast;
 import java.awt.Graphics2D;
 import java.awt.Point;
 import java.awt.Rectangle;
+import javax.swing.SwingUtilities;
 
 import com.threerings.media.sprite.ImageSprite;
 

src/java/com/threerings/cast/CompositedActionFrames.java

@@ -1,5 +1,5 @@
 //
-// $Id: CompositedActionFrames.java,v 1.17 2004/08/27 02:12:25 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -26,6 +26,7 @@ import com.samskivert.util.StringUtil;
 
 import com.threerings.media.image.Colorization;
 import com.threerings.media.image.ImageManager;
+import com.threerings.media.util.MultiFrameImage;
 
 import com.threerings.cast.CharacterComponent;
 import com.threerings.util.DirectionCodes;

src/java/com/threerings/cast/CompositedMultiFrameImage.java

@@ -1,5 +1,5 @@
 //
-// $Id: CompositedMultiFrameImage.java,v 1.2 2004/08/27 02:12:25 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -38,7 +38,7 @@ import com.threerings.cast.TrimmedMultiFrameImage;
 
 /**
  * Used to composite the action frames for a particular orientation of a
- * {@link CompositedActionSequence}.
+ * {@link CompositedActionFrames}.
  */
 public class CompositedMultiFrameImage
     implements TrimmedMultiFrameImage

src/java/com/threerings/crowd/chat/client/ChatDirector.java

@@ -313,7 +313,7 @@ public class ChatDirector extends BasicDirector
      * Requests that a speak message with the specified mode be generated
      * and delivered via the supplied speak service instance (which will
      * be associated with a particular "speak object"). The message will
-     * first be validated by all registered {@link ChatValidator}s (and
+     * first be validated by all registered {@link ChatFilter}s (and
      * possibly vetoed) before being dispatched.
      *
      * @param speakService the speak service to use when generating the
@@ -366,7 +366,7 @@ public class ChatDirector extends BasicDirector
      *
      * @param target the username of the user to which the tell message
      * should be delivered.
-     * @param message the contents of the tell message.
+     * @param msg the contents of the tell message.
      * @param rl an optional result listener if you'd like to be notified
      * of success or failure.
      */

src/java/com/threerings/crowd/chat/client/ChatService.java

@@ -1,5 +1,5 @@
 //
-// $Id: ChatService.java,v 1.14 2004/08/27 02:12:30 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -43,7 +43,7 @@ public interface ChatService extends InvocationService
         /**
          * Communicates the response to a {@link #tell} request.
          *
-         * @param idletime the number of ms the tellee has been idle or 0L
+         * @param idleTime the number of ms the tellee has been idle or 0L
          * if they are not idle.
          * @param awayMessage the away message configured by the told
          * player or null if they have no away message.

src/java/com/threerings/crowd/chat/data/ChatCodes.java

@@ -1,5 +1,5 @@
 //
-// $Id: ChatCodes.java,v 1.20 2004/08/27 02:12:31 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -23,6 +23,9 @@ package com.threerings.crowd.chat.data;
 
 import com.threerings.presents.data.InvocationCodes;
 
+import com.threerings.crowd.chat.client.ChatDirector;
+import com.threerings.crowd.chat.client.SpeakService;
+
 /**
  * Contains codes used by the chat invocation services.
  */

src/java/com/threerings/crowd/chat/server/ChatProvider.java

@@ -44,6 +44,7 @@ import com.threerings.crowd.server.AccessControl;
 import com.threerings.crowd.server.CrowdServer;
 
 import com.threerings.crowd.chat.client.ChatService.TellListener;
+import com.threerings.crowd.chat.client.ChatService;
 import com.threerings.crowd.chat.data.ChatCodes;
 import com.threerings.crowd.chat.data.UserMessage;
 
@@ -160,7 +161,7 @@ public class ChatProvider
     }
 
     /**
-     * Processes a {@link ClientService#broadcast} request.
+     * Processes a {@link ChatService#broadcast} request.
      */
     public void broadcast (ClientObject caller, String message,
                            InvocationListener listener)
@@ -223,7 +224,7 @@ public class ChatProvider
     }
 
     /**
-     * Processes a {@link ClientService#away} request.
+     * Processes a {@link ChatService#away} request.
      */
     public void away (ClientObject caller, String message)
     {

src/java/com/threerings/crowd/chat/server/SpeakProvider.java

@@ -35,6 +35,7 @@ import com.threerings.crowd.Log;
 import com.threerings.crowd.data.BodyObject;
 import com.threerings.crowd.server.CrowdServer;
 
+import com.threerings.crowd.chat.client.SpeakService;
 import com.threerings.crowd.chat.data.ChatCodes;
 import com.threerings.crowd.chat.data.ChatMessage;
 import com.threerings.crowd.chat.data.SpeakObject;

src/java/com/threerings/crowd/data/PlaceConfig.java

@@ -25,6 +25,9 @@ import com.samskivert.util.StringUtil;
 
 import com.threerings.io.TrackedStreamableObject;
 
+import com.threerings.crowd.client.LocationDirector;
+import com.threerings.crowd.client.PlaceController;
+
 /**
  * The place config class encapsulates the configuration information for a
  * particular type of place. The hierarchy of place config objects mimics

src/java/com/threerings/geom/GeomUtil.java

@@ -1,5 +1,5 @@
 //
-// $Id: GeomUtil.java,v 1.9 2004/08/27 02:12:35 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -114,9 +114,9 @@ public class GeomUtil
      * is only considered valid if it lies upon the segment.
      * Note that Point extends Point2D.
      *
-     * @param p1, p2 the coordinates of the first line.
+     * @param p1 and p2 the coordinates of the first line.
      * @param seg1 if the first line should be considered a segment.
-     * @param p3, p4 the coordinates of the second line.
+     * @param p3 and p4 the coordinates of the second line.
      * @param seg2 if the second line should be considered a segment.
      * @param result the point that will be filled in with the intersecting
      * point.

src/java/com/threerings/io/FramingOutputStream.java

@@ -1,5 +1,5 @@
 //
-// $Id: FramingOutputStream.java,v 1.5 2004/08/27 02:12:36 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -108,7 +108,7 @@ public class FramingOutputStream extends OutputStream
     /**
      * Writes the frame length to the beginning of our buffer and returns
      * it for writing to the appropriate channel. This should be followed
-     * by a call to {@link #reset} when the frame has been written.
+     * by a call to {@link #resetFrame} when the frame has been written.
      */
     public ByteBuffer frameAndReturnBuffer ()
     {

src/java/com/threerings/io/Streamer.java

@@ -1,5 +1,5 @@
 //
-// $Id: Streamer.java,v 1.9 2004/08/27 02:12:36 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -246,8 +246,8 @@ public class Streamer
      * specified stream.
      *
      * @param object the instance to be read from the stream.
-     * @param out the stream from which to read the instance.
+     * @param in the stream from which to read the instance.
-     * @param useWriter whether or not to use the custom
+     * @param useReader whether or not to use the custom
      * <code>readObject</code> if one exists.
      */
     public void readObject (

src/java/com/threerings/media/FrameManager.java

@@ -1,5 +1,5 @@
 //
-// $Id: FrameManager.java,v 1.55 2004/10/28 17:21:56 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -25,6 +25,7 @@ import java.applet.Applet;
 
 import java.awt.Component;
 import java.awt.Graphics2D;
+import java.awt.GraphicsDevice;
 import java.awt.KeyEventDispatcher;
 import java.awt.KeyboardFocusManager;
 import java.awt.Rectangle;

src/java/com/threerings/media/VirtualMediaPanel.java

@@ -282,7 +282,7 @@ public class VirtualMediaPanel extends MediaPanel
 
     /**
      * Called during our tick when we have adjusted the view location. The
-     * {@link _vbounds} will already have been updated to reflect our new
+     * {@link #_vbounds} will already have been updated to reflect our new
      * view coordinates.
      *
      * @param dx the delta scrolled in the x direction (in pixels).

src/java/com/threerings/media/animation/AnimationFrameSequencer.java

@@ -1,5 +1,5 @@
 //
-// $Id: AnimationFrameSequencer.java,v 1.8 2004/08/27 02:12:38 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -233,7 +233,7 @@ public interface AnimationFrameSequencer extends FrameSequencer
         /** The animation that we're sequencing for. */
         protected Animation _animation;
 
-        /** Used to dispatch {@link AnimationObserver#frameReached}. */
+        /** Used to dispatch {@link SequencedAnimationObserver#frameReached}. */
         protected static class FrameReachedOp implements ObserverList.ObserverOp
         {
             public FrameReachedOp (Animation anim, long when,

src/java/com/threerings/media/image/ImageManager.java

@@ -1,5 +1,5 @@
 //
-// $Id: ImageManager.java,v 1.60 2004/08/27 02:12:38 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -189,7 +189,7 @@ public class ImageManager
      * using the supplied path to identify the image.
      *
      * <p> Additionally the image is optimized for display in the current
-     * graphics configuration. Consider using {@link getMirage(String)}
+     * graphics configuration. Consider using {@link #getMirage(ImageKey)}
      * instead of prepared images as they (some day) will automatically
      * use volatile images to increase performance.
      */
@@ -203,10 +203,9 @@ public class ImageManager
      * obtaining the image from the supplied resource set.
      *
      * <p> Additionally the image is optimized for display in the current
-     * graphics configuration. Consider using {@link
+     * graphics configuration. Consider using {@link #getMirage(ImageKey)}
-     * getMirage(String,String)} instead of prepared images as they (some
+     * instead of prepared images as they (some day) will automatically
-     * day) will automatically use volatile images to increase
+     * use volatile images to increase performance.
-     * performance.
      */
     public BufferedImage getPreparedImage (String rset, String path)
     {
@@ -220,9 +219,9 @@ public class ImageManager
      *
      * <p> Additionally the image is optimized for display in the current
      * graphics configuration. Consider using {@link
-     * getMirage(String,String,Colorizationp[]} instead of prepared images
+     * #getMirage(ImageKey,Colorization[])} instead of prepared images as
-     * as they (some day) will automatically use volatile images to
+     * they (some day) will automatically use volatile images to increase
-     * increase performance.
+     * performance.
      */
     public BufferedImage getPreparedImage (String rset, String path,
                                            Colorization[] zations)

src/java/com/threerings/media/sound/MusicManager.java

@@ -75,7 +75,7 @@ public class MusicManager
     /**
      * Sets the volume for music.
      *
-     * @param val a volume parameter between 0f and 1f, inclusive.
+     * @param vol a volume parameter between 0f and 1f, inclusive.
      */
     public void setMusicVolume (float vol)
     {

src/java/com/threerings/media/sound/SoundManager.java

@@ -167,7 +167,7 @@ public class SoundManager
     /**
      * Sets the volume for all sound clips.
      *
-     * @param val a volume parameter between 0f and 1f, inclusive.
+     * @param vol a volume parameter between 0f and 1f, inclusive.
      */
     public void setClipVolume (float vol)
     {

src/java/com/threerings/media/sprite/SpriteIcon.java

@@ -1,5 +1,5 @@
 //
-// $Id: SpriteIcon.java,v 1.6 2004/08/27 02:12:41 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -38,8 +38,7 @@ public class SpriteIcon implements Icon
      * itself. This sprite should not be used for anything else while
      * being used in this icon because it will be "moved" when the icon is
      * rendered. The sprite's origin will be set to the bottom center of
-     * the label. If this is undesirable, the origin can be offset via
+     * the label.
-     * {@link #setOriginOffset}.
      */
     public SpriteIcon (Sprite sprite)
     {
@@ -51,8 +50,7 @@ public class SpriteIcon implements Icon
      * itself. This sprite should not be used for anything else while
      * being used in this icon because it will be "moved" when the icon is
      * rendered. The sprite's origin will be set to the bottom center of
-     * the label. If this is undesirable, the origin can be offset via
+     * the label.
-     * {@link #setOriginOffset}.
      *
      * @param sprite the sprite to render in this label.
      * @param padding the number of pixels of blank space to put on all

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

@@ -1,5 +1,5 @@
 //
-// $Id: TileSet.java,v 1.62 2004/10/28 17:49:02 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -152,7 +152,7 @@ public abstract class TileSet
     }
 
     /**
-     * Equivalent to {@link# getTile(int,Colorizer)} with a null
+     * Equivalent to {@link #getTile(int,Colorizer)} with a null
      * <code>Colorizer</code> argument.
      */
     public Tile getTile (int tileIndex)

src/java/com/threerings/media/tile/bundle/tools/TileSetBundler.java

@@ -1,5 +1,5 @@
 //
-// $Id: TileSetBundler.java,v 1.21 2004/08/27 02:12:43 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -197,7 +197,7 @@ public class TileSetBundler
      *
      * @param idBroker the tileset id broker that will be used to map
      * tileset names to tileset ids.
-     * @param bundleDef a file object pointing to the bundle description
+     * @param bundleDesc a file object pointing to the bundle description
      * file.
      * @param targetPath the path of the tileset bundle file that will be
      * created.
@@ -332,8 +332,8 @@ public class TileSetBundler
      * Finish the creation of a tileset bundle jar file.
      *
      * @param target the tileset bundle file that will be created.
-     * @param TileSetBundle contains the tilesets we'd like to save out to
+     * @param bundle contains the tilesets we'd like to save out to the
-     * the bundle.
+     * bundle.
      * @param improv the image provider.
      * @param imageBase the base directory for getting images for non
      * ObjectTileSet tilesets.

src/java/com/threerings/media/tile/tools/xml/TileSetRuleSet.java

@@ -1,5 +1,5 @@
 //
-// $Id: TileSetRuleSet.java,v 1.8 2004/08/27 02:12:44 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -26,6 +26,7 @@ import org.apache.commons.digester.RuleSetBase;
 
 import com.samskivert.util.StringUtil;
 import com.samskivert.xml.ValidatedSetNextRule.Validator;
+import com.samskivert.xml.ValidatedSetNextRule;
 
 import com.threerings.media.Log;
 import com.threerings.media.tile.TileSet;

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

@@ -1,5 +1,5 @@
 //
-// $Id: LineSegmentPath.java,v 1.30 2004/08/27 02:12:47 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -80,12 +80,8 @@ public class LineSegmentPath
     }
 
     /**
-     * Constructs a line segment path with the specified list of
+     * Constructs a line segment path with the specified list of points.
-     * points.  An arbitrary direction will be assigned to the
+     * An arbitrary direction will be assigned to the starting node.
-     * starting node.
-     *
-     * @param x the starting node x-position.
-     * @param y the starting node y-position.
      */
     public LineSegmentPath (List points)
     {

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

@@ -1,5 +1,5 @@
 //
-// $Id: Pathable.java,v 1.7 2004/08/27 02:12:47 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -23,6 +23,8 @@ package com.threerings.media.util;
 
 import java.awt.Rectangle;
 
+import com.threerings.util.DirectionCodes;
+
 /**
  * Used in conjunction with a {@link Path}.
  */

src/java/com/threerings/micasa/client/ChatPanel.java

@@ -37,6 +37,7 @@ import javax.swing.JTextField;
 import javax.swing.JTextPane;
 
 import javax.swing.event.AncestorEvent;
+import javax.swing.event.AncestorListener;
 
 import javax.swing.text.BadLocationException;
 import javax.swing.text.Document;

src/java/com/threerings/micasa/lobby/LobbyRegistry.java

@@ -1,5 +1,5 @@
 //
-// $Id: LobbyRegistry.java,v 1.11 2004/08/27 02:12:50 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -94,7 +94,6 @@ public class LobbyRegistry
      * Initializes the registry. It will use the supplied configuration
      * instance to determine which lobbies to load, etc.
      *
-     * @param config the server configuration.
      * @param invmgr a reference to the server's invocation manager.
      */
     public void init (InvocationManager invmgr)

src/java/com/threerings/miso/client/DirtyItemList.java

@@ -1,5 +1,5 @@
 //
-// $Id: DirtyItemList.java,v 1.30 2004/08/27 02:20:06 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -64,7 +64,7 @@ public class DirtyItemList
      * Appends the dirty object tile at the given coordinates to the dirty
      * item list.
      *
-     * @param scene the scene object that is dirty.
+     * @param scobj the scene object that is dirty.
      */
     public void appendDirtyObject (SceneObject scobj)
     {
@@ -217,7 +217,7 @@ public class DirtyItemList
 
     /**
      * Returns an abbreviated string representation of the two given dirty
-     * items. See {@link #toString(DirtyItem}.
+     * items. See {@link #toString(DirtyItem)}.
      */
     protected static String toString (DirtyItem a, DirtyItem b)
     {
@@ -229,7 +229,7 @@ public class DirtyItemList
 
     /**
      * Returns an abbreviated string representation of the given dirty
-     * items. See {@link #toString(DirtyItem}.
+     * items. See {@link #toString(DirtyItem)}.
      */
     protected static String toString (SortableArrayList items)
     {

src/java/com/threerings/miso/client/MisoScenePanel.java

@@ -424,8 +424,8 @@ public class MisoScenePanel extends VirtualMediaPanel
 
     /**
      * Programmatically "click" a scene object. This results in a call to
-     * {@link handleObjectPressed} with click coordinates in the center of
+     * {@link #handleObjectPressed} with click coordinates in the center
-     * the object.
+     * of the object.
      */
     public void pressObject (SceneObject scobj)
     {
@@ -846,7 +846,7 @@ public class MisoScenePanel extends VirtualMediaPanel
     /**
      * Called during the {@link #rethink} process, configures {@link
      * #_ibounds} to contain the bounds of the potentially "influential"
-     * world and {@link #_ivbounds} to contain bounds that are used to
+     * world and {@link #_vibounds} to contain bounds that are used to
      * determine which blocks should be resolved before making the view
      * visible.
      * 
@@ -1079,8 +1079,6 @@ public class MisoScenePanel extends VirtualMediaPanel
 
     /**
      * Change the hover object to the new object.
-     *
-     * @return true if we need to repaint the entire scene. Bah!
      */
     protected void changeHoverObject (Object newHover)
     {

src/java/com/threerings/miso/data/ObjectInfo.java

@@ -1,5 +1,5 @@
 //
-// $Id: ObjectInfo.java,v 1.7 2004/08/27 02:20:06 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -22,6 +22,8 @@
 package com.threerings.miso.data;
 
 import com.samskivert.util.StringUtil;
+
+import com.threerings.io.SimpleStreamableObject;
 import com.threerings.io.TrackedStreamableObject;
 import com.threerings.media.tile.TileUtil;
 

src/java/com/threerings/miso/util/MisoSceneMetrics.java

@@ -1,5 +1,5 @@
 //
-// $Id: MisoSceneMetrics.java,v 1.6 2004/08/27 02:20:10 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -21,6 +21,8 @@
 
 package com.threerings.miso.util;
 
+import com.threerings.miso.client.MisoScenePanel;
+
 /**
  * Contains information on the configuration of a particular isometric
  * view. The member data are public to facilitate convenient referencing

src/java/com/threerings/miso/util/MisoUtil.java

@@ -1,5 +1,5 @@
 //
-// $Id: MisoUtil.java,v 1.24 2004/08/27 02:20:10 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -471,7 +471,7 @@ public class MisoUtil
      * Adds the supplied fine coordinates to the supplied tile coordinates
      * to compute full coordinates.
      *
-     * @retun the point object supplied as <code>full</code>.
+     * @return the point object supplied as <code>full</code>.
      */
     public static Point tilePlusFineToFull (MisoSceneMetrics metrics,
                                             int tileX, int tileY,

src/java/com/threerings/parlor/client/GameConfigurator.java

@@ -1,5 +1,5 @@
 //
-// $Id: GameConfigurator.java,v 1.2 2004/08/27 02:20:12 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved

src/java/com/threerings/parlor/client/ParlorReceiver.java

@@ -1,5 +1,5 @@
 //
-// $Id: ParlorReceiver.java,v 1.4 2004/08/27 02:20:12 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -25,6 +25,7 @@ import com.threerings.util.Name;
 
 import com.threerings.presents.client.InvocationReceiver;
 
+import com.threerings.parlor.data.ParlorCodes;
 import com.threerings.parlor.game.GameConfig;
 
 /**

src/java/com/threerings/parlor/client/TableDirector.java

@@ -1,5 +1,5 @@
 //
-// $Id: TableDirector.java,v 1.11 2004/08/27 02:20:12 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -36,6 +36,7 @@ import com.threerings.crowd.data.PlaceObject;
 
 import com.threerings.parlor.Log;
 import com.threerings.parlor.data.Table;
+import com.threerings.parlor.data.TableLobbyObject;
 import com.threerings.parlor.game.GameConfig;
 import com.threerings.parlor.util.ParlorContext;
 

src/java/com/threerings/parlor/game/AIGameTicker.java

@@ -78,8 +78,6 @@ public class AIGameTicker extends Interval
 
     /**
      * Remove the specified manager from receiving AI ticks.
-     *
-     * @return true if there are no more games.
      */
     protected void removeAIGame (GameManager mgr)
     {

src/java/com/threerings/parlor/game/GameManagerDelegate.java

@@ -1,5 +1,5 @@
 //
-// $Id: GameManagerDelegate.java,v 1.9 2004/10/22 19:27:54 ray Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -57,7 +57,7 @@ public class GameManagerDelegate extends PlaceManagerDelegate
      * the game is IN_PLAY.
      *
      * @param pidx the player index to fake some gameplay for.
-     * @param skill the base skill level of the AI (0 - 100 inclusive).
+     * @param ai a record indicating the AI's configuration.
      */
     public void tickAI (int pidx, AI ai)
     {

src/java/com/threerings/parlor/turn/TurnGameController.java

@@ -1,5 +1,5 @@
 //
-// $Id: TurnGameController.java,v 1.7 2004/08/27 02:20:15 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -23,6 +23,8 @@ package com.threerings.parlor.turn;
 
 import com.threerings.util.Name;
 
+import com.threerings.parlor.game.GameController;
+
 /**
  * Games that wish to make use of the turn game services should have their
  * controller implement this interface and create an instance of {@link

src/java/com/threerings/parlor/turn/TurnGameManager.java

@@ -1,5 +1,5 @@
 //
-// $Id: TurnGameManager.java,v 1.11 2004/08/27 02:20:15 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -23,6 +23,8 @@ package com.threerings.parlor.turn;
 
 import com.threerings.util.Name;
 
+import com.threerings.parlor.game.GameManager;
+
 /**
  * A game manager that wishes to make use of the turn game services should
  * implement this interface and create a {@link TurnGameManagerDelegate}

src/java/com/threerings/parlor/turn/TurnGameObject.java

@@ -1,5 +1,5 @@
 //
-// $Id: TurnGameObject.java,v 1.7 2004/08/27 02:20:15 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -23,6 +23,8 @@ package com.threerings.parlor.turn;
 
 import com.threerings.util.Name;
 
+import com.threerings.parlor.game.GameObject;
+
 /**
  * Games that wish to support turn-based play must implement this
  * interface with their {@link GameObject}.

src/java/com/threerings/presents/data/InvocationMarshaller.java

@@ -1,5 +1,5 @@
 //
-// $Id: InvocationMarshaller.java,v 1.6 2004/08/27 02:20:19 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -28,6 +28,8 @@ import com.threerings.io.Streamable;
 import com.threerings.presents.Log;
 
 import com.threerings.presents.client.Client;
+import com.threerings.presents.client.InvocationService.ConfirmListener;
+import com.threerings.presents.client.InvocationService.ResultListener;
 import com.threerings.presents.client.InvocationService;
 
 import com.threerings.presents.dobj.DObjectManager;

src/java/com/threerings/presents/server/InvocationManager.java

@@ -1,5 +1,5 @@
 //
-// $Id: InvocationManager.java,v 1.23 2004/08/27 02:20:23 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -27,6 +27,7 @@ import com.samskivert.util.HashIntMap;
 import com.samskivert.util.LRUHashMap;
 import com.samskivert.util.StringUtil;
 
+import com.threerings.io.Streamable;
 import com.threerings.util.StreamableArrayList;
 
 import com.threerings.presents.Log;

src/java/com/threerings/presents/server/PresentsClient.java

@@ -636,10 +636,6 @@ public class PresentsClient
      * this session has been closed and unmapped. If the user logged off
      * before closing their connection, this will be preceded by a call to
      * {@link #sessionDidEnd}.
-     *
-     * @param clobj the client object is explicitly passed to this method
-     * because {@link #_clobj} may have already been cleared out if this
-     * is being called due to the termination of a session.
      */
     protected void sessionConnectionClosed ()
     {

src/java/com/threerings/presents/server/PresentsDObjectMgr.java

@@ -30,6 +30,7 @@ import sun.misc.Perf;
 
 import com.samskivert.util.HashIntMap;
 import com.samskivert.util.Histogram;
+import com.samskivert.util.Invoker;
 import com.samskivert.util.Queue;
 import com.samskivert.util.RunQueue;
 import com.samskivert.util.StringUtil;

src/java/com/threerings/presents/util/ResultAdapter.java

@@ -1,5 +1,5 @@
 //
-// $Id: ResultAdapter.java,v 1.2 2004/08/27 02:20:26 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -28,10 +28,10 @@ import com.threerings.presents.data.InvocationCodes;
 import com.threerings.presents.server.InvocationException;
 
 /**
- * Adapts the response from a {@link ResultListener} to an {@link
+ * Adapts the response from a {@link ResultListener} to an
- * InvocationService.ResultListener} if the failure is an instance fo
+ * <code>InvocationService.ResultListener</code> if the failure is an
- * {@link InvocationException} the message will be passed on to the result
+ * instance fo {@link InvocationException} the message will be passed on
- * listener, otherwise they will be provided with {@link
+ * to the result listener, otherwise they will be provided with {@link
  * InvocationCodes#INTERNAL_ERROR}.
  */
 public class ResultAdapter implements ResultListener

src/java/com/threerings/puzzle/client/PuzzleService.java

@@ -1,5 +1,5 @@
 //
-// $Id: PuzzleService.java,v 1.5 2004/10/21 02:54:43 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -28,8 +28,7 @@ import com.threerings.puzzle.data.SolitairePuzzleConfig;
 
 /**
  * The puzzle services provide a mechanism by which the client can enter
- * and leave puzzles. These services should not be used directly, but
+ * and leave puzzles.
- * instead should be accessed via the {@link PuzzleDirector}.
  */
 public interface PuzzleService extends InvocationService
 {

src/java/com/threerings/puzzle/drop/client/DropBoardView.java

@@ -1,5 +1,5 @@
 //
-// $Id: DropBoardView.java,v 1.9 2004/10/21 18:07:37 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -297,7 +297,7 @@ public abstract class DropBoardView extends PuzzleBoardView
     /**
      * Returns true if the piece that is supposed to be at the specified
      * coordinates is not yet there but is actually en route to that
-     * location (due to a call to {@link #movePIece}).
+     * location (due to a call to {@link #movePiece}).
      */
     protected boolean isMoving (int px, int py)
     {
@@ -446,7 +446,7 @@ public abstract class DropBoardView extends PuzzleBoardView
      * @param score the score text to display.
      * @param color the color of the text.
      * @param fontSize the size of the text; a value between 0 and {@link
-     * #getPuzzleFontSizeCount} - 1.
+     * #FONT_SIZES}.length - 1.
      */
     public ScoreAnimation createScoreAnimation (
         String score, Color color, int fontSize)
@@ -484,7 +484,7 @@ public abstract class DropBoardView extends PuzzleBoardView
      * @param score the score text to display.
      * @param color the color of the text.
      * @param fontSize the size of the text; a value between 0 and {@link
-     * #getPuzzleFontSizeCount} - 1.
+     * #FONT_SIZES}.length - 1.
      * @param x the left coordinate in board coordinates of the rectangle
      * within which the score is to be centered.
      * @param y the bottom coordinate in board coordinates of the

src/java/com/threerings/puzzle/drop/data/SegmentInfo.java

@@ -1,5 +1,5 @@
 //
-// $Id: SegmentInfo.java,v 1.3 2004/08/27 02:20:30 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -22,6 +22,7 @@
 package com.threerings.puzzle.drop.data;
 
 import com.samskivert.util.StringUtil;
+import com.threerings.util.DirectionCodes;
 
 /**
  * Describes a segment of pieces in a {@link DropBoard}.

src/java/com/threerings/puzzle/drop/server/DropManagerDelegate.java

@@ -1,5 +1,5 @@
 //
-// $Id: DropManagerDelegate.java,v 1.5 2004/08/29 06:50:47 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -51,7 +51,7 @@ import com.threerings.puzzle.drop.util.PieceDropper;
  * <p> A puzzle game using these services will then need to extend this
  * delegate, implementing the necessary methods to customize it for the
  * particulars of their game and then register it with their game manager
- * via {@link GameManager#addDelegate}.
+ * via {@link PuzzleManager#addDelegate}.
  *
  * <p> It also keeps track of, for each player, board level information,
  * and player game status.  Miscellaneous utility routines are provided

src/java/com/threerings/puzzle/drop/util/PieceDropLogic.java

@@ -1,5 +1,5 @@
 //
-// $Id: PieceDropLogic.java,v 1.3 2004/08/27 02:20:31 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -21,6 +21,8 @@
 
 package com.threerings.puzzle.drop.util;
 
+import com.threerings.util.DirectionCodes;
+
 import com.threerings.puzzle.drop.data.DropBoard;
 
 /**

src/java/com/threerings/resource/ResourceManager.java

@@ -168,7 +168,7 @@ public class ResourceManager
 
     /**
      * Creates a resource manager with the specified class loader via
-     * which to load classes. See {@link ResourceManager(String)} for
+     * which to load classes. See {@link #ResourceManager(String)} for
      * further documentation.
      */
     public ResourceManager (String resourceRoot, ClassLoader loader)

src/java/com/threerings/tools/xml/CompiledConfigParser.java

@@ -1,5 +1,5 @@
 //
-// $Id: CompiledConfigParser.java,v 1.5 2004/08/27 02:20:35 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -29,6 +29,9 @@ import java.io.Serializable;
 import org.xml.sax.SAXException;
 import org.apache.commons.digester.Digester;
 
+import com.threerings.tools.CompiledConfigTask;
+import com.threerings.util.CompiledConfig;
+
 /**
  * An abstract base implementation of a parser that is used to compile
  * configuration definitions into config objects for use by the client and

src/java/com/threerings/whirled/client/SceneDirector.java

@@ -1,5 +1,5 @@
 //
-// $Id: SceneDirector.java,v 1.28 2004/08/27 02:20:39 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -31,6 +31,7 @@ import com.threerings.presents.client.BasicDirector;
 import com.threerings.presents.client.Client;
 
 import com.threerings.crowd.client.LocationDirector;
+import com.threerings.crowd.client.LocationObserver;
 import com.threerings.crowd.data.PlaceConfig;
 
 import com.threerings.whirled.Log;
@@ -67,7 +68,7 @@ public class SceneDirector extends BasicDirector
      * which the scene director will coordinate when changing location.
      * @param screp the entity from which the scene director will load
      * scene data from the local client scene storage.
-     * @param dsfact the factory that knows which derivation of {@link
+     * @param fact the factory that knows which derivation of {@link
      * Scene} to create for the current system.
      */
     public SceneDirector (WhirledContext ctx, LocationDirector locdir,

src/java/com/threerings/whirled/server/SceneRegistry.java

@@ -1,5 +1,5 @@
 //
-// $Id: SceneRegistry.java,v 1.24 2004/08/27 02:20:43 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -150,7 +150,7 @@ public class SceneRegistry
      * {@link #resolveScene} returns).
      *
      * @param sceneId the id of the scene to resolve.
-     * @param resolver a reference to a callback instance that will be
+     * @param target a reference to a callback instance that will be
      * notified when the scene has been resolved (which may be immediately
      * if the scene is already active).
      */

src/java/com/threerings/whirled/spot/client/SpotSceneDirector.java

@@ -169,7 +169,7 @@ public class SpotSceneDirector extends BasicDirector
      * specified location.
      *
      * @param loc the new location to which to move.
-     * @param obs will be notified of success or failure. Most client
+     * @param listener will be notified of success or failure. Most client
      * entities find out about location changes via changes to the
      * occupant info data, but the initiator of a location change request
      * can be notified of its success or failure, primarily so that it can

src/java/com/threerings/whirled/spot/client/SpotService.java

@@ -1,5 +1,5 @@
 //
-// $Id: SpotService.java,v 1.17 2004/08/27 02:20:44 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -39,7 +39,7 @@ public interface SpotService extends InvocationService
      * Requests to traverse the specified portal.
      *
      * @param portalId the portal to be traversed.
-     * @param descSceneVer the version of the destination scene data that
+     * @param destSceneVer the version of the destination scene data that
      * the client has in its local repository.
      */
     public void traversePortal (

src/java/com/threerings/whirled/spot/data/Cluster.java

@@ -1,5 +1,5 @@
 //
-// $Id: Cluster.java,v 1.8 2004/08/27 02:20:45 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -72,6 +72,6 @@ public class Cluster extends Rectangle
         return StringUtil.fieldsToString(this);
     }
 
-    /** Used for {@link #geyKey}. */
+    /** Used for {@link #getKey}. */
     protected transient Integer _key;
 }

src/java/com/threerings/whirled/spot/data/ClusteredBodyObject.java

@@ -1,5 +1,5 @@
 //
-// $Id: ClusteredBodyObject.java,v 1.4 2004/08/27 02:20:45 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -24,7 +24,7 @@ package com.threerings.whirled.spot.data;
 import com.threerings.whirled.data.ScenedBodyObject;
 
 /**
- * Defines some required methods for a {@link BodyObject} that is to
+ * Defines some required methods for a {@link ScenedBodyObject} that is to
  * participate in the Whirled Spot system.
  */
 public interface ClusteredBodyObject extends ScenedBodyObject

src/java/com/threerings/whirled/spot/data/Location.java

@@ -1,5 +1,5 @@
 //
-// $Id: Location.java,v 1.10 2004/08/27 02:20:45 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -22,6 +22,7 @@
 package com.threerings.whirled.spot.data;
 
 import com.threerings.io.TrackedStreamableObject;
+import com.threerings.util.DirectionCodes;
 import com.threerings.util.DirectionUtil;
 
 /**

src/java/com/threerings/whirled/spot/data/SceneLocation.java

@@ -1,5 +1,5 @@
 //
-// $Id: SceneLocation.java,v 1.2 2004/08/27 02:20:45 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -67,6 +67,6 @@ public class SceneLocation extends Location
         return _key;
     }
 
-    /** Used for {@link #geyKey}. */
+    /** Used for {@link #getKey}. */
     protected transient Integer _key;
 }

src/java/com/threerings/whirled/spot/server/SpotSceneManager.java

@@ -1,5 +1,5 @@
 //
-// $Id: SpotSceneManager.java,v 1.52 2004/08/27 02:20:47 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -217,11 +217,6 @@ public class SpotSceneManager extends SceneManager
      *
      * @param source the body to be moved.
      * @param loc the location to which to move the body.
-     * @param cluster if zero, a new cluster will be created and assigned
-     * to the moving user; if -1, the moving user will be removed from any
-     * cluster they currently occupy and not made to occupy a new cluster;
-     * if the bodyOid of another user, the moving user will be made to
-     * join the other user's cluster.
      *
      * @exception InvocationException thrown with a reason code explaining
      * the failure if there is a problem processing the request.

src/java/com/threerings/whirled/zone/data/SceneSummary.java

@@ -1,5 +1,5 @@
 //
-// $Id: SceneSummary.java,v 1.8 2004/08/27 02:20:51 mdb Exp $
+// $Id$
 //
 // Narya library - tools for developing networked games
 // Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -24,6 +24,7 @@ package com.threerings.whirled.zone.data;
 import com.samskivert.util.StringUtil;
 
 import com.threerings.io.Streamable;
+import com.threerings.util.DirectionCodes;
 import com.threerings.util.DirectionUtil;
 
 /**