Big fat Bernie javadoc cleanup.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3310 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Michael Bayne
2005-01-24 23:08:21 +00:00
parent dd04679568
commit afabea71ad
65 changed files with 158 additions and 132 deletions
@@ -1,5 +1,5 @@
//
// $Id: SceneDirector.java,v 1.28 2004/08/27 02:20:39 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -31,6 +31,7 @@ import com.threerings.presents.client.BasicDirector;
import com.threerings.presents.client.Client;
import com.threerings.crowd.client.LocationDirector;
import com.threerings.crowd.client.LocationObserver;
import com.threerings.crowd.data.PlaceConfig;
import com.threerings.whirled.Log;
@@ -67,7 +68,7 @@ public class SceneDirector extends BasicDirector
* which the scene director will coordinate when changing location.
* @param screp the entity from which the scene director will load
* scene data from the local client scene storage.
* @param dsfact the factory that knows which derivation of {@link
* @param fact the factory that knows which derivation of {@link
* Scene} to create for the current system.
*/
public SceneDirector (WhirledContext ctx, LocationDirector locdir,
@@ -1,5 +1,5 @@
//
// $Id: SceneRegistry.java,v 1.24 2004/08/27 02:20:43 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -150,7 +150,7 @@ public class SceneRegistry
* {@link #resolveScene} returns).
*
* @param sceneId the id of the scene to resolve.
* @param resolver a reference to a callback instance that will be
* @param target a reference to a callback instance that will be
* notified when the scene has been resolved (which may be immediately
* if the scene is already active).
*/
@@ -169,7 +169,7 @@ public class SpotSceneDirector extends BasicDirector
* specified location.
*
* @param loc the new location to which to move.
* @param obs will be notified of success or failure. Most client
* @param listener will be notified of success or failure. Most client
* entities find out about location changes via changes to the
* occupant info data, but the initiator of a location change request
* can be notified of its success or failure, primarily so that it can
@@ -1,5 +1,5 @@
//
// $Id: SpotService.java,v 1.17 2004/08/27 02:20:44 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -39,7 +39,7 @@ public interface SpotService extends InvocationService
* Requests to traverse the specified portal.
*
* @param portalId the portal to be traversed.
* @param descSceneVer the version of the destination scene data that
* @param destSceneVer the version of the destination scene data that
* the client has in its local repository.
*/
public void traversePortal (
@@ -1,5 +1,5 @@
//
// $Id: Cluster.java,v 1.8 2004/08/27 02:20:45 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -72,6 +72,6 @@ public class Cluster extends Rectangle
return StringUtil.fieldsToString(this);
}
/** Used for {@link #geyKey}. */
/** Used for {@link #getKey}. */
protected transient Integer _key;
}
@@ -1,5 +1,5 @@
//
// $Id: ClusteredBodyObject.java,v 1.4 2004/08/27 02:20:45 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -24,7 +24,7 @@ package com.threerings.whirled.spot.data;
import com.threerings.whirled.data.ScenedBodyObject;
/**
* Defines some required methods for a {@link BodyObject} that is to
* Defines some required methods for a {@link ScenedBodyObject} that is to
* participate in the Whirled Spot system.
*/
public interface ClusteredBodyObject extends ScenedBodyObject
@@ -1,5 +1,5 @@
//
// $Id: Location.java,v 1.10 2004/08/27 02:20:45 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -22,6 +22,7 @@
package com.threerings.whirled.spot.data;
import com.threerings.io.TrackedStreamableObject;
import com.threerings.util.DirectionCodes;
import com.threerings.util.DirectionUtil;
/**
@@ -1,5 +1,5 @@
//
// $Id: SceneLocation.java,v 1.2 2004/08/27 02:20:45 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -67,6 +67,6 @@ public class SceneLocation extends Location
return _key;
}
/** Used for {@link #geyKey}. */
/** Used for {@link #getKey}. */
protected transient Integer _key;
}
@@ -1,5 +1,5 @@
//
// $Id: SpotSceneManager.java,v 1.52 2004/08/27 02:20:47 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -217,11 +217,6 @@ public class SpotSceneManager extends SceneManager
*
* @param source the body to be moved.
* @param loc the location to which to move the body.
* @param cluster if zero, a new cluster will be created and assigned
* to the moving user; if -1, the moving user will be removed from any
* cluster they currently occupy and not made to occupy a new cluster;
* if the bodyOid of another user, the moving user will be made to
* join the other user's cluster.
*
* @exception InvocationException thrown with a reason code explaining
* the failure if there is a problem processing the request.
@@ -1,5 +1,5 @@
//
// $Id: SceneSummary.java,v 1.8 2004/08/27 02:20:51 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -24,6 +24,7 @@ package com.threerings.whirled.zone.data;
import com.samskivert.util.StringUtil;
import com.threerings.io.Streamable;
import com.threerings.util.DirectionCodes;
import com.threerings.util.DirectionUtil;
/**