Javadoc edits.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@576 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Michael Bayne
2001-10-26 01:40:22 +00:00
parent d102a47f13
commit b632510cb1
8 changed files with 35 additions and 34 deletions
+8 -8
View File
@@ -1,5 +1,5 @@
// //
// $Id: TileUtil.java,v 1.1 2001/10/26 01:17:21 shaper Exp $ // $Id: TileUtil.java,v 1.2 2001/10/26 01:40:22 mdb Exp $
package com.threerings.cast; package com.threerings.cast;
@@ -17,13 +17,13 @@ import com.threerings.cast.CharacterComponent.ComponentFrames;
public class TileUtil public class TileUtil
{ {
/** /**
* Returns a {@link ComponentFrames} object containing the frames * Returns a {@link CharacterComponent.ComponentFrames} object
* of animation used to render the sprite while standing or * containing the frames of animation used to render the sprite while
* walking in each of the directions it may face. The tileset id * standing or walking in each of the directions it may face. The
* referenced must contain <code>Sprite.NUM_DIRECTIONS</code> rows * tileset id referenced must contain
* of tiles, with each row containing first the single standing * <code>Sprite.NUM_DIRECTIONS</code> rows of tiles, with each row
* tile, followed by <code>frameCount</code> tiles describing the * containing first the single standing tile, followed by
* walking animation. * <code>frameCount</code> tiles describing the walking animation.
* *
* @param tilemgr the tile manager to retrieve tiles from. * @param tilemgr the tile manager to retrieve tiles from.
* @param tsid the tileset id containing the sprite tiles. * @param tsid the tileset id containing the sprite tiles.
@@ -1,5 +1,5 @@
// //
// $Id: PlaceManager.java,v 1.22 2001/10/24 01:00:09 mdb Exp $ // $Id: PlaceManager.java,v 1.23 2001/10/26 01:40:22 mdb Exp $
package com.threerings.crowd.server; package com.threerings.crowd.server;
@@ -57,11 +57,11 @@ public class PlaceManager
/** /**
* A place manager derived class is likely to have a corresponding * A place manager derived class is likely to have a corresponding
* derived class of {@link PlaceObject} that it will be managing. * derived class of {@link com.threerings.crowd.data.PlaceObject} that
* Derived classes should override this method and return the class * it will be managing. Derived classes should override this method
* object for the place object derived class they desire to use. The * and return the class object for the place object derived class they
* place registry will use this method to create the proper place * desire to use. The place registry will use this method to create
* object during the place creation process. * the proper place object during the place creation process.
* *
* @return the class of the class, derived from {@link PlaceObject}, * @return the class of the class, derived from {@link PlaceObject},
* that this manager wishes to manage. * that this manager wishes to manage.
@@ -1,5 +1,5 @@
// //
// $Id: IsoSceneViewModelListener.java,v 1.1 2001/10/18 21:01:44 shaper Exp $ // $Id: IsoSceneViewModelListener.java,v 1.2 2001/10/26 01:40:22 mdb Exp $
package com.threerings.miso.scene; package com.threerings.miso.scene;
@@ -13,7 +13,8 @@ package com.threerings.miso.scene;
public interface IsoSceneViewModelListener public interface IsoSceneViewModelListener
{ {
/** /**
* Called by the {@link IsoSceneView} when the model is changed. * Called by the {@link com.threerings.miso.scene.IsoSceneView} when
* the model is changed.
*/ */
public void viewChanged (int event); public void viewChanged (int event);
@@ -1,5 +1,5 @@
// //
// $Id: ParlorCodes.java,v 1.9 2001/10/23 20:23:29 mdb Exp $ // $Id: ParlorCodes.java,v 1.10 2001/10/26 01:40:22 mdb Exp $
package com.threerings.parlor.client; package com.threerings.parlor.client;
@@ -64,12 +64,12 @@ public interface ParlorCodes extends InvocationCodes
/** The response identifier for a table created response. This is /** The response identifier for a table created response. This is
* mapped by the invocation services to a call to {@link * mapped by the invocation services to a call to {@link
* TableManager#handleTableCreated}. */ * TableDirector#handleTableCreated}. */
public static final String TABLE_CREATED_RESPONSE = "TableCreated"; public static final String TABLE_CREATED_RESPONSE = "TableCreated";
/** The response identifier for a create failed response. This is /** The response identifier for a create failed response. This is
* mapped by the invocation services to a call to {@link * mapped by the invocation services to a call to {@link
* TableManager#handleCreateFailed}. */ * TableDirector#handleCreateFailed}. */
public static final String CREATE_FAILED_RESPONSE = "CreateFailed"; public static final String CREATE_FAILED_RESPONSE = "CreateFailed";
/** The message identifier for a join table request. */ /** The message identifier for a join table request. */
@@ -77,7 +77,7 @@ public interface ParlorCodes extends InvocationCodes
/** The response identifier for a join failed response. This is mapped /** The response identifier for a join failed response. This is mapped
* by the invocation services to a call to {@link * by the invocation services to a call to {@link
* TableManager#handleJoinFailed}. */ * TableDirector#handleJoinFailed}. */
public static final String JOIN_FAILED_RESPONSE = "JoinFailed"; public static final String JOIN_FAILED_RESPONSE = "JoinFailed";
/** The message identifier for a leave table request. */ /** The message identifier for a leave table request. */
@@ -85,7 +85,7 @@ public interface ParlorCodes extends InvocationCodes
/** The response identifier for a leave failed response. This is /** The response identifier for a leave failed response. This is
* mapped by the invocation services to a call to {@link * mapped by the invocation services to a call to {@link
* TableManager#handleLeaveFailed}. */ * TableDirector#handleLeaveFailed}. */
public static final String LEAVE_FAILED_RESPONSE = "LeaveFailed"; public static final String LEAVE_FAILED_RESPONSE = "LeaveFailed";
/** An error code returned when a user requests to join a table that /** An error code returned when a user requests to join a table that
@@ -1,5 +1,5 @@
// //
// $Id: ParlorService.java,v 1.10 2001/10/23 23:47:01 mdb Exp $ // $Id: ParlorService.java,v 1.11 2001/10/26 01:40:22 mdb Exp $
package com.threerings.parlor.client; package com.threerings.parlor.client;
@@ -99,7 +99,7 @@ public class ParlorService implements ParlorCodes
/** /**
* You probably don't want to call this directly, but want to call * You probably don't want to call this directly, but want to call
* {@link TableManager#createTable}. Requests that a new table be * {@link TableDirector#createTable}. Requests that a new table be
* created. * created.
* *
* @param client a connected, operational client instance. * @param client a connected, operational client instance.
@@ -122,7 +122,7 @@ public class ParlorService implements ParlorCodes
/** /**
* You probably don't want to call this directly, but want to call * You probably don't want to call this directly, but want to call
* {@link TableManager#joinTable}. Requests that the current user * {@link TableDirector#joinTable}. Requests that the current user
* be added to the specified table at the specified position. * be added to the specified table at the specified position.
* *
* @param client a connected, operational client instance. * @param client a connected, operational client instance.
@@ -148,7 +148,7 @@ public class ParlorService implements ParlorCodes
/** /**
* You probably don't want to call this directly, but want to call * You probably don't want to call this directly, but want to call
* {@link TableManager#leaveTable}. Requests that the current user * {@link TableDirector#leaveTable}. Requests that the current user
* be removed from the specified table. * be removed from the specified table.
* *
* @param client a connected, operational client instance. * @param client a connected, operational client instance.
@@ -1,12 +1,12 @@
// //
// $Id: SeatednessObserver.java,v 1.1 2001/10/23 20:23:29 mdb Exp $ // $Id: SeatednessObserver.java,v 1.2 2001/10/26 01:40:22 mdb Exp $
package com.threerings.parlor.client; package com.threerings.parlor.client;
/** /**
* Entites that wish to hear about when we sit down at a table or stand up * Entites that wish to hear about when we sit down at a table or stand up
* from a table can implement this interface and register themselves with * from a table can implement this interface and register themselves with
* the {@link TableManager}. * the {@link TableDirector}.
*/ */
public interface SeatednessObserver public interface SeatednessObserver
{ {
@@ -1,14 +1,14 @@
// //
// $Id: TableObserver.java,v 1.1 2001/10/23 02:22:16 mdb Exp $ // $Id: TableObserver.java,v 1.2 2001/10/26 01:40:22 mdb Exp $
package com.threerings.parlor.client; package com.threerings.parlor.client;
import com.threerings.parlor.data.Table; import com.threerings.parlor.data.Table;
/** /**
* The {@link TableManager} converts distributed object events into higher * The {@link TableDirector} converts distributed object events into
* level callbacks to implementers of this interface, which are expected * higher level callbacks to implementers of this interface, which are
* to render these events sensically in a user interface. * expected to render these events sensically in a user interface.
*/ */
public interface TableObserver public interface TableObserver
{ {
@@ -1,5 +1,5 @@
// //
// $Id: TableManager.java,v 1.3 2001/10/25 23:02:17 mdb Exp $ // $Id: TableManager.java,v 1.4 2001/10/26 01:40:22 mdb Exp $
package com.threerings.parlor.server; package com.threerings.parlor.server;
@@ -34,8 +34,8 @@ import com.threerings.parlor.game.GameManager;
* A table manager can be used by a place manager to take care of the * A table manager can be used by a place manager to take care of the
* management of a table matchmaking service in the place managed by the * management of a table matchmaking service in the place managed by the
* place manager. The place manager need instantiate a table manager and * place manager. The place manager need instantiate a table manager and
* implement the {@link TableLobbyManager} interface to provide access to * implement the {@link TableManagerProvider} interface to provide access
* the table manager for the associated invocation services. * to the table manager for the associated invocation services.
*/ */
public class TableManager public class TableManager
implements ParlorCodes, PlaceRegistry.CreationObserver, OidListListener implements ParlorCodes, PlaceRegistry.CreationObserver, OidListListener