From f862f5363f6fe8164ff172a31e673e2c2bbd427d Mon Sep 17 00:00:00 2001 From: Charlie Groves Date: Thu, 21 Aug 2008 01:52:03 +0000 Subject: [PATCH] Javadoc fixery git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@735 c613c5cb-e716-0410-b11b-feb51c14d237 --- .../parlor/card/server/CardGameSender.java | 1 + .../com/threerings/parlor/server/ParlorSender.java | 1 + .../parlor/server/PlayManagerDelegate.java | 2 -- .../parlor/turn/server/TurnGameManagerDelegate.java | 10 ++++++---- src/java/com/threerings/stats/data/IntSetStat.java | 2 +- .../threerings/whirled/server/SceneRegistry.java | 13 +++++++------ .../com/threerings/whirled/server/SceneSender.java | 1 + .../whirled/zone/server/ZoneRegistry.java | 5 +++-- .../threerings/whirled/zone/server/ZoneSender.java | 1 + 9 files changed, 21 insertions(+), 15 deletions(-) diff --git a/src/java/com/threerings/parlor/card/server/CardGameSender.java b/src/java/com/threerings/parlor/card/server/CardGameSender.java index fd48bde0..7e4c55b5 100644 --- a/src/java/com/threerings/parlor/card/server/CardGameSender.java +++ b/src/java/com/threerings/parlor/card/server/CardGameSender.java @@ -22,6 +22,7 @@ package com.threerings.parlor.card.server; 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.Hand; import com.threerings.presents.data.ClientObject; diff --git a/src/java/com/threerings/parlor/server/ParlorSender.java b/src/java/com/threerings/parlor/server/ParlorSender.java index b59eaeed..013f3010 100644 --- a/src/java/com/threerings/parlor/server/ParlorSender.java +++ b/src/java/com/threerings/parlor/server/ParlorSender.java @@ -22,6 +22,7 @@ package com.threerings.parlor.server; import com.threerings.parlor.client.ParlorDecoder; +import com.threerings.parlor.client.ParlorReceiver; import com.threerings.parlor.game.data.GameConfig; import com.threerings.presents.data.ClientObject; import com.threerings.presents.server.InvocationSender; diff --git a/src/java/com/threerings/parlor/server/PlayManagerDelegate.java b/src/java/com/threerings/parlor/server/PlayManagerDelegate.java index 83123449..c0047b2b 100644 --- a/src/java/com/threerings/parlor/server/PlayManagerDelegate.java +++ b/src/java/com/threerings/parlor/server/PlayManagerDelegate.java @@ -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. - * - * @return a casted {@link PlayerObject} reference if the method returns at all. */ protected void verifyIsPlayer (ClientObject caller) throws InvocationException diff --git a/src/java/com/threerings/parlor/turn/server/TurnGameManagerDelegate.java b/src/java/com/threerings/parlor/turn/server/TurnGameManagerDelegate.java index ca04b00a..fe66029a 100644 --- a/src/java/com/threerings/parlor/turn/server/TurnGameManagerDelegate.java +++ b/src/java/com/threerings/parlor/turn/server/TurnGameManagerDelegate.java @@ -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 - * (probably the submission of a valid move of some sort by the turn holding player), it should - * call this function to cause this turn to end and the next to begin. + * (probably the submission of a valid move of some sort by the turn holding player), it + * should call this function to cause this turn to end and the next to begin. * - *

If the game is no longer in play (see {@link TurnGame#isInPlay}) after having called + *

+ * 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 * not automatically be started. * - *

If the game is in play, but the next turn should not be started immediately, the game + *

+ * 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 * -1 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} diff --git a/src/java/com/threerings/stats/data/IntSetStat.java b/src/java/com/threerings/stats/data/IntSetStat.java index b5422c26..43d72041 100644 --- a/src/java/com/threerings/stats/data/IntSetStat.java +++ b/src/java/com/threerings/stats/data/IntSetStat.java @@ -44,7 +44,7 @@ public class IntSetStat extends SetStat /** * 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) { diff --git a/src/java/com/threerings/whirled/server/SceneRegistry.java b/src/java/com/threerings/whirled/server/SceneRegistry.java index 48f74b02..ec50ef80 100644 --- a/src/java/com/threerings/whirled/server/SceneRegistry.java +++ b/src/java/com/threerings/whirled/server/SceneRegistry.java @@ -39,6 +39,7 @@ import com.threerings.presents.server.InvocationManager; import com.threerings.crowd.data.BodyObject; import com.threerings.crowd.data.PlaceConfig; import com.threerings.crowd.server.LocationManager; +import com.threerings.crowd.server.LocationProvider; import com.threerings.crowd.server.PlaceManager; import com.threerings.crowd.server.PlaceRegistry; @@ -138,7 +139,7 @@ public class SceneRegistry SceneManager scmgr = getSceneManager(sceneId); return (scmgr == null) ? ("null:" + sceneId) : scmgr.where(); } - + /** * Requests that the specified scene be resolved, which means loaded into the server and * initialized if the scene is not currently active. The supplied callback instance will be @@ -194,7 +195,7 @@ public class SceneRegistry /** * 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) { @@ -207,14 +208,14 @@ public class SceneRegistry /** * 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) { // remove them from their occupied place (clears out scene info as well) _locman.leaveOccupiedPlace(source); } - + /** * Adds a callback for when the scene is resolved. Returns true if this is the first such * thing (and thusly, the caller should actually fire off scene resolution) or false if we've @@ -224,12 +225,12 @@ public class SceneRegistry { List penders = _penders.get(sceneId); boolean newList = false; - + if (penders == null) { _penders.put(sceneId, penders = Lists.newArrayList()); newList = true; } - + penders.add(rl); return newList; } diff --git a/src/java/com/threerings/whirled/server/SceneSender.java b/src/java/com/threerings/whirled/server/SceneSender.java index 7a89a763..95790620 100644 --- a/src/java/com/threerings/whirled/server/SceneSender.java +++ b/src/java/com/threerings/whirled/server/SceneSender.java @@ -24,6 +24,7 @@ package com.threerings.whirled.server; import com.threerings.presents.data.ClientObject; import com.threerings.presents.server.InvocationSender; import com.threerings.whirled.client.SceneDecoder; +import com.threerings.whirled.client.SceneReceiver; /** * Used to issue notifications to a {@link SceneReceiver} instance on a diff --git a/src/java/com/threerings/whirled/zone/server/ZoneRegistry.java b/src/java/com/threerings/whirled/zone/server/ZoneRegistry.java index 3a5e5e47..59ec1f5c 100644 --- a/src/java/com/threerings/whirled/zone/server/ZoneRegistry.java +++ b/src/java/com/threerings/whirled/zone/server/ZoneRegistry.java @@ -33,6 +33,7 @@ import com.threerings.presents.server.InvocationManager; import com.threerings.crowd.data.BodyObject; import com.threerings.crowd.server.LocationManager; +import com.threerings.crowd.server.LocationProvider; import com.threerings.whirled.server.SceneRegistry; 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 * 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 * 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 - * {@link LocationProvider#leaveOccupiedPlace}. + * {@link LocationProvider#leavePlace}. * * @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}). diff --git a/src/java/com/threerings/whirled/zone/server/ZoneSender.java b/src/java/com/threerings/whirled/zone/server/ZoneSender.java index 6e86c5dd..7cf49f2a 100644 --- a/src/java/com/threerings/whirled/zone/server/ZoneSender.java +++ b/src/java/com/threerings/whirled/zone/server/ZoneSender.java @@ -24,6 +24,7 @@ package com.threerings.whirled.zone.server; import com.threerings.presents.data.ClientObject; import com.threerings.presents.server.InvocationSender; 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