From 5fbf4e17daa99aa7c86d24d1746af24aecfbdf36 Mon Sep 17 00:00:00 2001
From: Michael Bayne <mdb@threerings.net>
Date: Fri, 13 Jul 2007 22:27:08 +0000
Subject: [PATCH] More documentation cleanups, widening.

git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@357 c613c5cb-e716-0410-b11b-feb51c14d237
---
 .../whirled/client/SceneDirector.java         | 34 +++++++++----------
 .../whirled/client/SceneReceiver.java         | 11 +++---
 2 files changed, 21 insertions(+), 24 deletions(-)

diff --git a/src/java/com/threerings/whirled/client/SceneDirector.java b/src/java/com/threerings/whirled/client/SceneDirector.java
index 31a58d54..1611077d 100644
--- a/src/java/com/threerings/whirled/client/SceneDirector.java
+++ b/src/java/com/threerings/whirled/client/SceneDirector.java
@@ -55,8 +55,8 @@ import com.threerings.whirled.data.SceneUpdate;
  * LocationObserver#locationChangeFailed}.
  */
 public class SceneDirector extends BasicDirector
-    implements SceneCodes, LocationDirector.FailureHandler,
-               SceneReceiver, SceneService.SceneMoveListener
+    implements SceneCodes, LocationDirector.FailureHandler, SceneReceiver,
+               SceneService.SceneMoveListener
 {
     /**
      * Used to recover from a problem after a completed moveTo.
@@ -348,20 +348,8 @@ public class SceneDirector extends BasicDirector
         clearScene();
     }
 
-    // documentation inherited from interface
-    public void forcedMove (int sceneId)
-    {
-        Log.info("Moving at request of server [sceneId=" + sceneId + "].");
-
-        // clear out our old scene and place data
-        didLeaveScene();
-
-        // move to the new scene
-        moveTo(sceneId);
-    }
-
     /**
-     * Sets the moveHandler for use in recoverFailedMove.
+     * Sets the moveHandler for use in {@link #recoverFailedMove}.
      */
     public void setMoveHandler (MoveHandler handler)
     {
@@ -376,9 +364,19 @@ public class SceneDirector extends BasicDirector
         }
     }
 
-    /**
-     * Called when something breaks down in the process of performing a {@link #moveTo} request.
-     */
+    // from interface SceneReceiver
+    public void forcedMove (int sceneId)
+    {
+        Log.info("Moving at request of server [sceneId=" + sceneId + "].");
+
+        // clear out our old scene and place data
+        didLeaveScene();
+
+        // move to the new scene
+        moveTo(sceneId);
+    }
+
+    // from interface LocationDirector.FailureHandler
     public void recoverFailedMove (int placeId)
     {
         // we'll need this momentarily
diff --git a/src/java/com/threerings/whirled/client/SceneReceiver.java b/src/java/com/threerings/whirled/client/SceneReceiver.java
index 008750cc..ec63e598 100644
--- a/src/java/com/threerings/whirled/client/SceneReceiver.java
+++ b/src/java/com/threerings/whirled/client/SceneReceiver.java
@@ -24,16 +24,15 @@ package com.threerings.whirled.client;
 import com.threerings.presents.client.InvocationReceiver;
 
 /**
- * Defines, for the scene services, a set of notifications delivered
- * asynchronously by the server to the client.
+ * Defines, for the scene services, a set of notifications delivered asynchronously by the server
+ * to the client.
  */
 public interface SceneReceiver extends InvocationReceiver
 {
     /**
-     * Used to communicate a required move notification to the client. The
-     * server will have removed the client from their existing scene
-     * and the client is then responsible for generating a {@link
-     * SceneService#moveTo} request to move to the new scene.
+     * Used to communicate a required move notification to the client. The server will have removed
+     * the client from their existing scene and the client is then responsible for generating a
+     * {@link SceneService#moveTo} request to move to the new scene.
      */
     public void forcedMove (int sceneId);
 }