Javadoc fixery

git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@735 c613c5cb-e716-0410-b11b-feb51c14d237
This commit is contained in:
Charlie Groves
2008-08-21 01:52:03 +00:00
parent 9025ecc6f0
commit f862f5363f
9 changed files with 21 additions and 15 deletions
@@ -22,6 +22,7 @@
package com.threerings.parlor.card.server; package com.threerings.parlor.card.server;
import com.threerings.parlor.card.client.CardGameDecoder; import com.threerings.parlor.card.client.CardGameDecoder;
import com.threerings.parlor.card.client.CardGameReceiver;
import com.threerings.parlor.card.data.Card; import com.threerings.parlor.card.data.Card;
import com.threerings.parlor.card.data.Hand; import com.threerings.parlor.card.data.Hand;
import com.threerings.presents.data.ClientObject; import com.threerings.presents.data.ClientObject;
@@ -22,6 +22,7 @@
package com.threerings.parlor.server; package com.threerings.parlor.server;
import com.threerings.parlor.client.ParlorDecoder; import com.threerings.parlor.client.ParlorDecoder;
import com.threerings.parlor.client.ParlorReceiver;
import com.threerings.parlor.game.data.GameConfig; import com.threerings.parlor.game.data.GameConfig;
import com.threerings.presents.data.ClientObject; import com.threerings.presents.data.ClientObject;
import com.threerings.presents.server.InvocationSender; import com.threerings.presents.server.InvocationSender;
@@ -61,8 +61,6 @@ public class PlayManagerDelegate extends PlaceManagerDelegate
/** /**
* Checks that the caller in question is a player if the game is not a party game. * Checks that the caller in question is a player if the game is not a party game.
*
* @return a casted {@link PlayerObject} reference if the method returns at all.
*/ */
protected void verifyIsPlayer (ClientObject caller) protected void verifyIsPlayer (ClientObject caller)
throws InvocationException throws InvocationException
@@ -116,14 +116,16 @@ public class TurnGameManagerDelegate extends GameManagerDelegate
/** /**
* Called to end the turn. Whatever indication a game manager has that the turn has ended * Called to end the turn. Whatever indication a game manager has that the turn has ended
* (probably the submission of a valid move of some sort by the turn holding player), it should * (probably the submission of a valid move of some sort by the turn holding player), it
* call this function to cause this turn to end and the next to begin. * should call this function to cause this turn to end and the next to begin.
* *
* <p> If the game is no longer in play (see {@link TurnGame#isInPlay}) after having called * <p>
* If the game is no longer in play (see {@link TurnGameObject#isInPlay}) after having called
* {@link TurnGameManager#turnDidEnd} and {@link #setNextTurnHolder}, then the next turn will * {@link TurnGameManager#turnDidEnd} and {@link #setNextTurnHolder}, then the next turn will
* not automatically be started. * not automatically be started.
* *
* <p> If the game is in play, but the next turn should not be started immediately, the game * <p>
* If the game is in play, but the next turn should not be started immediately, the game
* manager should have {@link #setNextTurnHolder} set the {@link #_turnIdx} field to * manager should have {@link #setNextTurnHolder} set the {@link #_turnIdx} field to
* <code>-1</code> which will cause us to not start the next turn. To start things back up * <code>-1</code> which will cause us to not start the next turn. To start things back up
* again it would set {@link #_turnIdx} to the next turn holder and call {@link #startTurn} * again it would set {@link #_turnIdx} to the next turn holder and call {@link #startTurn}
@@ -44,7 +44,7 @@ public class IntSetStat extends SetStat<Integer>
/** /**
* Constructs a new IntSetStat that will store up to maxSize ints. * Constructs a new IntSetStat that will store up to maxSize ints.
* *
* @param the maximum number of ints to store in the IntSetStat. Must be <= 255. * @param maxSize the maximum number of ints to store in the IntSetStat. Must be <= 255.
*/ */
public IntSetStat (int maxSize) public IntSetStat (int maxSize)
{ {
@@ -39,6 +39,7 @@ import com.threerings.presents.server.InvocationManager;
import com.threerings.crowd.data.BodyObject; import com.threerings.crowd.data.BodyObject;
import com.threerings.crowd.data.PlaceConfig; import com.threerings.crowd.data.PlaceConfig;
import com.threerings.crowd.server.LocationManager; import com.threerings.crowd.server.LocationManager;
import com.threerings.crowd.server.LocationProvider;
import com.threerings.crowd.server.PlaceManager; import com.threerings.crowd.server.PlaceManager;
import com.threerings.crowd.server.PlaceRegistry; import com.threerings.crowd.server.PlaceRegistry;
@@ -194,7 +195,7 @@ public class SceneRegistry
/** /**
* Ejects the specified body from their current scene and sends them a request to move to the * Ejects the specified body from their current scene and sends them a request to move to the
* specified new scene. This is the scene-equivalent to {@link LocationProvider#moveBody}. * specified new scene. This is the scene-equivalent to {@link LocationProvider#moveTo}.
*/ */
public void moveBody (BodyObject source, int sceneId) public void moveBody (BodyObject source, int sceneId)
{ {
@@ -207,7 +208,7 @@ public class SceneRegistry
/** /**
* Ejects the specified body from their current scene and zone. This is the zone equivalent to * Ejects the specified body from their current scene and zone. This is the zone equivalent to
* {@link LocationProvider#leaveOccupiedPlace}. * {@link LocationProvider#leavePlace}.
*/ */
public void leaveOccupiedScene (BodyObject source) public void leaveOccupiedScene (BodyObject source)
{ {
@@ -24,6 +24,7 @@ package com.threerings.whirled.server;
import com.threerings.presents.data.ClientObject; import com.threerings.presents.data.ClientObject;
import com.threerings.presents.server.InvocationSender; import com.threerings.presents.server.InvocationSender;
import com.threerings.whirled.client.SceneDecoder; import com.threerings.whirled.client.SceneDecoder;
import com.threerings.whirled.client.SceneReceiver;
/** /**
* Used to issue notifications to a {@link SceneReceiver} instance on a * Used to issue notifications to a {@link SceneReceiver} instance on a
@@ -33,6 +33,7 @@ import com.threerings.presents.server.InvocationManager;
import com.threerings.crowd.data.BodyObject; import com.threerings.crowd.data.BodyObject;
import com.threerings.crowd.server.LocationManager; import com.threerings.crowd.server.LocationManager;
import com.threerings.crowd.server.LocationProvider;
import com.threerings.whirled.server.SceneRegistry; import com.threerings.whirled.server.SceneRegistry;
import com.threerings.whirled.zone.client.ZoneService; import com.threerings.whirled.zone.client.ZoneService;
@@ -88,7 +89,7 @@ public class ZoneRegistry
/** /**
* Ejects the specified body from their current scene and sends them a request to move to the * Ejects the specified body from their current scene and sends them a request to move to the
* specified new zone and scene. This is the zone-equivalent to {@link * specified new zone and scene. This is the zone-equivalent to {@link
* LocationProvider#moveBody}. * LocationProvider#moveTo}.
* *
* @return null if the user was forcibly moved, or a string indicating the reason for denial of * @return null if the user was forcibly moved, or a string indicating the reason for denial of
* departure of their current zone (from {@link ZoneManager#ratifyBodyExit}). * departure of their current zone (from {@link ZoneManager#ratifyBodyExit}).
@@ -114,7 +115,7 @@ public class ZoneRegistry
/** /**
* Ejects the specified body from their current scene and zone. This is the zone equivalent to * Ejects the specified body from their current scene and zone. This is the zone equivalent to
* {@link LocationProvider#leaveOccupiedPlace}. * {@link LocationProvider#leavePlace}.
* *
* @return null if the user was forcibly moved, or a string indicating the reason for denial of * @return null if the user was forcibly moved, or a string indicating the reason for denial of
* departure of their current zone (from {@link ZoneManager#ratifyBodyExit}). * departure of their current zone (from {@link ZoneManager#ratifyBodyExit}).
@@ -24,6 +24,7 @@ package com.threerings.whirled.zone.server;
import com.threerings.presents.data.ClientObject; import com.threerings.presents.data.ClientObject;
import com.threerings.presents.server.InvocationSender; import com.threerings.presents.server.InvocationSender;
import com.threerings.whirled.zone.client.ZoneDecoder; import com.threerings.whirled.zone.client.ZoneDecoder;
import com.threerings.whirled.zone.client.ZoneReceiver;
/** /**
* Used to issue notifications to a {@link ZoneReceiver} instance on a * Used to issue notifications to a {@link ZoneReceiver} instance on a