Documentation repairs.

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

src/java/com/threerings/crowd/client/PlacePanel.java

@@ -1,5 +1,5 @@
 //
-// $Id: PlacePanel.java,v 1.1 2002/07/09 21:05:33 mdb Exp $
+// $Id: PlacePanel.java,v 1.2 2002/10/27 18:49:51 mdb Exp $
 
 package com.threerings.crowd.client;
 
@@ -11,8 +11,8 @@ import com.samskivert.swing.ControllerProvider;
 import com.threerings.crowd.data.PlaceObject;
 
 /**
- * A useful base class for client interfaces which wish to make use of
- * {@link a} JPanel as their top-level {@link PlaceView}.
+ * A useful base class for client interfaces which wish to make use of a
+ * {@link JPanel} as their top-level {@link PlaceView}.
  */
 public class PlacePanel extends JPanel
     implements ControllerProvider, PlaceView

src/java/com/threerings/io/FieldMarshaller.java

@@ -1,5 +1,5 @@
 //
-// $Id: FieldMarshaller.java,v 1.1 2002/07/23 05:42:34 mdb Exp $
+// $Id: FieldMarshaller.java,v 1.2 2002/10/27 18:49:51 mdb Exp $
 
 package com.threerings.io;
 
@@ -97,7 +97,7 @@ public abstract class FieldMarshaller
 
     /**
      * Creates instances of all known field marshaller types and populates
-     * the {@link _marshallers} table with them. This is called the first
+     * the {@link #_marshallers} table with them. This is called the first
      * time a marshaller is requested.
      */
     protected static void createMarshallers ()

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

@@ -1,5 +1,5 @@
 //
-// $Id: TileSet.java,v 1.33 2002/10/09 00:23:51 mdb Exp $
+// $Id: TileSet.java,v 1.34 2002/10/27 18:49:51 mdb Exp $
 
 package com.threerings.media.tile;
 
@@ -246,7 +246,8 @@ public abstract class TileSet
     /**
      * Returns the tileset image (which is loaded if it has not yet been
      * loaded). Generally this is not called by external entities, rather
-     * {@link #getTileImage} or {@link #getTile} is used.
+     * {@link #getTile} is used and the image rendered by rendering the
+     * tile.
      *
      * @return the tileset image or null if an error occurred loading the
      * image.

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

@@ -1,5 +1,5 @@
 //
-// $Id: ParlorService.java,v 1.13 2002/08/14 19:07:52 mdb Exp $
+// $Id: ParlorService.java,v 1.14 2002/10/27 18:49:51 mdb Exp $
 
 package com.threerings.parlor.client;
 
@@ -46,9 +46,9 @@ public interface ParlorService extends InvocationService
 
     /**
      * You probably don't want to call this directly, but want to call one
-     * of {@link ParlorDirector#accept}, {@link ParlorDirector#refuse}, or
-     * {@link ParlorDirector#counter}. Requests that an invitation
-     * response be delivered with the specified parameters.
+     * of {@link Invitation#accept}, {@link Invitation#refuse}, or {@link
+     * Invitation#counter}. Requests that an invitation response be
+     * delivered with the specified parameters.
      *
      * @param client a connected, operational client instance.
      * @param inviteId the unique id previously assigned by the server to
@@ -67,7 +67,7 @@ public interface ParlorService extends InvocationService
 
     /**
      * You probably don't want to call this directly, but want to call
-     * {@link ParlorDirector#cancel}. Requests that an outstanding
+     * {@link Invitation#cancel}. Requests that an outstanding
      * invitation be cancelled.
      *
      * @param client a connected, operational client instance.

src/java/com/threerings/presents/client/InvocationReceiver.java

@@ -1,5 +1,5 @@
 //
-// $Id: InvocationReceiver.java,v 1.5 2002/08/14 19:07:54 mdb Exp $
+// $Id: InvocationReceiver.java,v 1.6 2002/10/27 18:49:51 mdb Exp $
 
 package com.threerings.presents.client;
 
@@ -10,7 +10,7 @@ import com.threerings.presents.dobj.DSet;
  * extending this interface. Actual notification receivers will implement
  * the requisite receiver interface definition and register themselves
  * with the {@link InvocationDirector} using the generated {@link
- * InvocationDispatcher} class specific to the notification receiver
+ * InvocationDecoder} class specific to the notification receiver
  * interface in question. For example:
  *
  * <pre>
@@ -19,7 +19,7 @@ import com.threerings.presents.dobj.DSet;
  *     public FooDirector (PresentsContext ctx)
  *     {
  *         InvocationDirector idir = ctx.getClient().getInvocationDirector();
- *         idir.registerReceiver(new FooDispatcher(this));
+ *         idir.registerReceiver(new FooDecoder(this));
  *     }
  * }
  * </pre>

src/java/com/threerings/presents/client/LoggingListener.java

@@ -1,12 +1,13 @@
 //
-// $Id: LoggingListener.java,v 1.1 2002/08/14 19:07:54 mdb Exp $
+// $Id: LoggingListener.java,v 1.2 2002/10/27 18:49:51 mdb Exp $
 
 package com.threerings.presents.client;
 
 import com.samskivert.util.Log;
 
 /**
- * Implements the basic {@link InvocationListener} and logs the failure.
+ * Implements the basic {@link InvocationService.InvocationListener} and
+ * logs the failure.
  */
 public class LoggingListener
     implements InvocationService.InvocationListener

src/java/com/threerings/presents/dobj/DSet.java

@@ -1,5 +1,5 @@
 //
-// $Id: DSet.java,v 1.21 2002/10/15 21:01:39 ray Exp $
+// $Id: DSet.java,v 1.22 2002/10/27 18:49:51 mdb Exp $
 
 package com.threerings.presents.dobj;
 
@@ -27,7 +27,7 @@ import com.threerings.presents.Log;
  * requirement that the object provide a key which will be used to
  * identify entry equality. Thus an entry is declared to be in a set of
  * the object returned by that entry's {@link Entry#getKey} method is
- * equal (using {@link Object#equal}) to the entry returned by the {@link
+ * equal (using {@link Object#equals}) to the entry returned by the {@link
  * Entry#getKey} method of some other entry in the set. Additionally, in
  * the case of entry removal, only the key for the entry to be removed
  * will be transmitted with the removal event to save network