From 671d7ddce15952ac1efcacc28e13b4864b8a4df2 Mon Sep 17 00:00:00 2001
From: Michael Bayne <mdb@threerings.net>
Date: Tue, 12 Feb 2002 07:01:54 +0000
Subject: [PATCH] Documentation fixes.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@990 542714f4-19e9-0310-aa3c-eee0fc999fb1
---
 .../parlor/turn/TurnGameManagerDelegate.java     | 16 ++++++++++------
 .../threerings/parlor/turn/TurnGameObject.java   |  4 +++-
 2 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/src/java/com/threerings/parlor/turn/TurnGameManagerDelegate.java b/src/java/com/threerings/parlor/turn/TurnGameManagerDelegate.java
index ea99bfffa..3a4d89dec 100644
--- a/src/java/com/threerings/parlor/turn/TurnGameManagerDelegate.java
+++ b/src/java/com/threerings/parlor/turn/TurnGameManagerDelegate.java
@@ -1,5 +1,5 @@
 //
-// $Id: TurnGameManagerDelegate.java,v 1.1 2002/02/12 06:57:30 mdb Exp $
+// $Id: TurnGameManagerDelegate.java,v 1.2 2002/02/12 07:01:54 mdb Exp $
 
 package com.threerings.parlor.turn;
 
@@ -19,7 +19,11 @@ import com.threerings.parlor.util.MathUtil;
  * endTurn()
  * </pre>
  *
- * They must also implement the {@link TurnGameManager} interface.
+ * They must also implement the {@link TurnGameManager} interface. If the
+ * game requires specialized behavior from its delegate, it can extend the
+ * delegate and override the many methods that have been provided for just
+ * such a purpose (e.g. {@link #setFirstTurnHolder}, {@link
+ * #setNextTurnHolder}).
  */
 public class TurnGameManagerDelegate
 {
@@ -108,10 +112,10 @@ public class TurnGameManagerDelegate
      * turn, the game manager should arrange for {@link
      * #setNextTurnHolder} to set the {@link #_turnIdx} field to -1 which
      * will cause us not to start the next turn. It can then call {@link
-     * #endGame} if the game is over or do whatever else it needs to do
-     * outside the context of the turn flow.  To start things back up
-     * again it would set {@link #_turnIdx} to the next turn holder and
-     * call {@link #startTurn} itself.
+     * GameManager#endGame} if the game is over or do whatever else it
+     * needs to do outside the context of the turn flow.  To start things
+     * back up again it would set {@link #_turnIdx} to the next turn
+     * holder and call {@link #startTurn} itself.
      */
     public void endTurn ()
     {
diff --git a/src/java/com/threerings/parlor/turn/TurnGameObject.java b/src/java/com/threerings/parlor/turn/TurnGameObject.java
index 670440fa4..ed4662746 100644
--- a/src/java/com/threerings/parlor/turn/TurnGameObject.java
+++ b/src/java/com/threerings/parlor/turn/TurnGameObject.java
@@ -1,8 +1,10 @@
 //
-// $Id: TurnGameObject.java,v 1.2 2002/02/12 06:57:30 mdb Exp $
+// $Id: TurnGameObject.java,v 1.3 2002/02/12 07:01:54 mdb Exp $
 
 package com.threerings.parlor.turn;
 
+import com.threerings.parlor.game.GameObject;
+
 /**
  * Games that wish to support turn-based play must implement this
  * interface with their {@link GameObject}.