diff --git a/build.xml b/build.xml index 4635813b4..5fa580c1b 100644 --- a/build.xml +++ b/build.xml @@ -82,7 +82,7 @@ - + diff --git a/src/main/java/com/threerings/admin/data/AdminMarshaller.java b/src/main/java/com/threerings/admin/data/AdminMarshaller.java index 566cf813b..014137318 100644 --- a/src/main/java/com/threerings/admin/data/AdminMarshaller.java +++ b/src/main/java/com/threerings/admin/data/AdminMarshaller.java @@ -40,7 +40,7 @@ public class AdminMarshaller extends InvocationMarshaller implements AdminService { /** - * Marshalls results to implementations of {@link AdminService.ConfigInfoListener}. + * Marshalls results to implementations of {@code AdminService.ConfigInfoListener}. */ public static class ConfigInfoMarshaller extends ListenerMarshaller implements ConfigInfoListener diff --git a/src/main/java/com/threerings/admin/web/gwt/ConfigServiceAsync.java b/src/main/java/com/threerings/admin/web/gwt/ConfigServiceAsync.java index e86cd121e..a3f6eb82f 100644 --- a/src/main/java/com/threerings/admin/web/gwt/ConfigServiceAsync.java +++ b/src/main/java/com/threerings/admin/web/gwt/ConfigServiceAsync.java @@ -27,17 +27,17 @@ import com.threerings.admin.web.gwt.ConfigService.ConfigurationRecord; import com.threerings.admin.web.gwt.ConfigService.ConfigurationResult; /** - * Provides the asynchronous version of {@link com.threerings.admin.web.gwt.AdminService}. + * Provides the asynchronous version of {@link ConfigService}. */ public interface ConfigServiceAsync { /** - * The async version of {@link com.threerings.admin.web.gwt.ConfigService#getConfig}. + * The async version of {@link ConfigService#getConfiguration}. */ public void getConfiguration (AsyncCallback callback); /** - * The async version of {@link com.threerings.admin.web.gwt.ConfigService#updateConfiguration}. + * The async version of {@link ConfigService#updateConfiguration}. */ public void updateConfiguration ( String key, ConfigField[] updates, AsyncCallback callback); diff --git a/src/main/java/com/threerings/crowd/chat/client/ChatDirector.java b/src/main/java/com/threerings/crowd/chat/client/ChatDirector.java index f18634c17..e39b01f4b 100644 --- a/src/main/java/com/threerings/crowd/chat/client/ChatDirector.java +++ b/src/main/java/com/threerings/crowd/chat/client/ChatDirector.java @@ -148,7 +148,6 @@ public class ChatDirector extends BasicDirector * register itself as a location observer so that it can automatically process place * constrained chat. * - * @param msgmgr the message manager via which we do our translations. * @param bundle the message bundle from which we obtain our chat-related translation strings. */ public ChatDirector (CrowdContext ctx, String bundle) @@ -894,7 +893,7 @@ public class ChatDirector extends BasicDirector return buf.toString(); } - /** Helper function for {@link #mogrifyChat(String,boolean,boolean)}. */ + /** Helper function for {@link #mogrifyChat(String,byte,boolean,boolean)}. */ protected StringBuffer mogrifyChat ( StringBuffer buf, boolean transformsAllowed, boolean capFirst) { diff --git a/src/main/java/com/threerings/crowd/chat/client/ChatService.java b/src/main/java/com/threerings/crowd/chat/client/ChatService.java index e42ea091f..ee6560719 100644 --- a/src/main/java/com/threerings/crowd/chat/client/ChatService.java +++ b/src/main/java/com/threerings/crowd/chat/client/ChatService.java @@ -52,7 +52,6 @@ public interface ChatService extends InvocationService * Requests that a tell message be delivered to the user with username equal to * target. * - * @param client a connected, operational client instance. * @param target the username of the user to which the tell message should be delivered. * @param message the contents of the message. * @param listener the reference that will receive the tell response. @@ -62,7 +61,6 @@ public interface ChatService extends InvocationService /** * Requests that a message be broadcast to all users in the system. * - * @param client a connected, operational client instance. * @param message the contents of the message. * @param listener the reference that will receive a failure response. */ diff --git a/src/main/java/com/threerings/crowd/chat/data/ChatMarshaller.java b/src/main/java/com/threerings/crowd/chat/data/ChatMarshaller.java index eacdebed0..d4c4f6d3e 100644 --- a/src/main/java/com/threerings/crowd/chat/data/ChatMarshaller.java +++ b/src/main/java/com/threerings/crowd/chat/data/ChatMarshaller.java @@ -42,7 +42,7 @@ public class ChatMarshaller extends InvocationMarshaller implements ChatService { /** - * Marshalls results to implementations of {@link ChatService.TellListener}. + * Marshalls results to implementations of {@code ChatService.TellListener}. */ public static class TellMarshaller extends ListenerMarshaller implements TellListener diff --git a/src/main/java/com/threerings/crowd/chat/server/ChatHistory.java b/src/main/java/com/threerings/crowd/chat/server/ChatHistory.java index fa36fd691..8a5c56be4 100644 --- a/src/main/java/com/threerings/crowd/chat/server/ChatHistory.java +++ b/src/main/java/com/threerings/crowd/chat/server/ChatHistory.java @@ -155,7 +155,7 @@ public class ChatHistory } /** - * Causes the chat history for the given user to be held briefly after the {@link #clear()} + * Causes the chat history for the given user to be held briefly after the {@link #clear} * call so that session observers can grab it. */ public void hold (Name username) diff --git a/src/main/java/com/threerings/crowd/client/LocationService.java b/src/main/java/com/threerings/crowd/client/LocationService.java index a796b1536..ed9ce41e1 100644 --- a/src/main/java/com/threerings/crowd/client/LocationService.java +++ b/src/main/java/com/threerings/crowd/client/LocationService.java @@ -46,8 +46,6 @@ public interface LocationService extends InvocationService /** * Requests that this client's body be moved to the specified location. * - * @param client a reference to the client object that defines the context in which this - * invocation service should be executed. * @param placeId the object id of the place object to which the body should be moved. * @param listener the listener that will be informed of success or failure. */ diff --git a/src/main/java/com/threerings/crowd/data/BodyObject.java b/src/main/java/com/threerings/crowd/data/BodyObject.java index 45a36f946..d781e9641 100644 --- a/src/main/java/com/threerings/crowd/data/BodyObject.java +++ b/src/main/java/com/threerings/crowd/data/BodyObject.java @@ -132,7 +132,7 @@ public class BodyObject extends ClientObject /** * Return the {@link ClientObject} that represent our driving user's connection. This is - * the reverse operation of {@link BodyLocator#forClient} and should match it. The default + * the reverse operation of {@code BodyLocator.forClient} and should match it. The default * implementation assumes the client object and the body object are one and the same. * * Do not return null here once this object is in the wild. diff --git a/src/main/java/com/threerings/crowd/data/LocationMarshaller.java b/src/main/java/com/threerings/crowd/data/LocationMarshaller.java index f18bf3cb1..850f54eae 100644 --- a/src/main/java/com/threerings/crowd/data/LocationMarshaller.java +++ b/src/main/java/com/threerings/crowd/data/LocationMarshaller.java @@ -40,7 +40,7 @@ public class LocationMarshaller extends InvocationMarshaller implements LocationService { /** - * Marshalls results to implementations of {@link LocationService.MoveListener}. + * Marshalls results to implementations of {@code LocationService.MoveListener}. */ public static class MoveMarshaller extends ListenerMarshaller implements MoveListener diff --git a/src/main/java/com/threerings/crowd/data/TokenRing.java b/src/main/java/com/threerings/crowd/data/TokenRing.java index 85a586d7d..8e27fe74c 100644 --- a/src/main/java/com/threerings/crowd/data/TokenRing.java +++ b/src/main/java/com/threerings/crowd/data/TokenRing.java @@ -26,7 +26,7 @@ import com.threerings.io.SimpleStreamableObject; /** * Defines access control tokens that convey certain privileges to users. * - * @see BodyObject#CrowdPermissionPolicy + * @see BodyObject.CrowdPermissionPolicy */ public class TokenRing extends SimpleStreamableObject { diff --git a/src/main/java/com/threerings/crowd/server/CrowdObjectAccess.java b/src/main/java/com/threerings/crowd/server/CrowdObjectAccess.java index 706044c7e..597ef5c46 100644 --- a/src/main/java/com/threerings/crowd/server/CrowdObjectAccess.java +++ b/src/main/java/com/threerings/crowd/server/CrowdObjectAccess.java @@ -66,7 +66,8 @@ public class CrowdObjectAccess }; /** - * Extends the access control in {@link #PLACE} to allow Bureau clients to subscribe. + * Extends the access control in {@link PlaceAccessController} to allow Bureau clients to + * subscribe. */ @Singleton public static class BureauAccessController extends PlaceAccessController diff --git a/src/main/java/com/threerings/crowd/server/PlaceManager.java b/src/main/java/com/threerings/crowd/server/PlaceManager.java index 7f3983f4d..789d2a32b 100644 --- a/src/main/java/com/threerings/crowd/server/PlaceManager.java +++ b/src/main/java/com/threerings/crowd/server/PlaceManager.java @@ -510,7 +510,7 @@ public class PlaceManager /** * Creates an access controller for this place's distributed object, which by default is {@link - * CrowdObjectAccess#PLACE}. + * PlaceAccessController}. */ protected AccessController getAccessController () { @@ -639,7 +639,7 @@ public class PlaceManager * Adds this occupant's info to the {@link PlaceObject}. This is called in a transaction on the * place object so if a derived class needs to add additional information for an occupant it * should override this method. It may opt to add the information before calling super if it - * wishes to rely on its information being configured when {@link #bodyAdded} is called. + * wishes to rely on its information being configured when {@link #bodyEntered} is called. */ protected void addOccupantInfo (BodyObject body, OccupantInfo info) { diff --git a/src/main/java/com/threerings/nio/conman/Connection.java b/src/main/java/com/threerings/nio/conman/Connection.java index 0cd585ef9..01336826c 100644 --- a/src/main/java/com/threerings/nio/conman/Connection.java +++ b/src/main/java/com/threerings/nio/conman/Connection.java @@ -34,7 +34,6 @@ import java.nio.channels.SocketChannel; */ public abstract class Connection implements NetEventHandler { - /** The key used by the NIO code to track this connection. */ public SelectionKey selkey; diff --git a/src/main/java/com/threerings/nio/conman/ServerSocketChannelAcceptor.java b/src/main/java/com/threerings/nio/conman/ServerSocketChannelAcceptor.java index 068b477d2..3536edafc 100644 --- a/src/main/java/com/threerings/nio/conman/ServerSocketChannelAcceptor.java +++ b/src/main/java/com/threerings/nio/conman/ServerSocketChannelAcceptor.java @@ -45,8 +45,8 @@ public class ServerSocketChannelAcceptor { /** * Configures the connection manager with the hostname and ports on which it will listen for - * socket connections. This must be called before the connection manager is started (via - * {@via #start}) as the sockets will be bound at that time. + * socket connections. This must be called before the connection manager is started as the + * sockets will be bound at that time. * * @param socketHostname the hostname to which we bind our sockets or null to bind to all * interfaces. diff --git a/src/main/java/com/threerings/presents/client/Client.java b/src/main/java/com/threerings/presents/client/Client.java index 63ed549b5..0af58de94 100644 --- a/src/main/java/com/threerings/presents/client/Client.java +++ b/src/main/java/com/threerings/presents/client/Client.java @@ -128,7 +128,7 @@ public class Client * ports (which will be tried in succession). * * @see #logon - * @see #moveToServer(String,int[],ConfirmListener) + * @see #moveToServer */ public void setServer (String hostname, int[] ports) { @@ -140,7 +140,7 @@ public class Client * ports (which will be tried in succession), and datagram ports. * * @see #logon - * @see #moveToServer(String,int[],ConfirmListener) + * @see #moveToServer */ public void setServer (String hostname, int[] ports, int[] datagramPorts) { @@ -969,8 +969,7 @@ public class Client return false; } - /** Handles the process of switching between servers. - * See {@link Client#moveToServer(String,int[],int[],ConfirmListener)}. */ + /** Handles the process of switching between servers. See {@link Client#moveToServer}. */ protected class ServerSwitcher extends ClientAdapter { public ServerSwitcher ( diff --git a/src/main/java/com/threerings/presents/data/InvocationMarshaller.java b/src/main/java/com/threerings/presents/data/InvocationMarshaller.java index dd0bfbd3a..3614411cd 100644 --- a/src/main/java/com/threerings/presents/data/InvocationMarshaller.java +++ b/src/main/java/com/threerings/presents/data/InvocationMarshaller.java @@ -148,7 +148,7 @@ public class InvocationMarshaller } /** - * Defines a marshaller for the standard {@link InvocationService.ConfirmListener}. + * Defines a marshaller for the standard {@code InvocationService.ConfirmListener}. */ public static class ConfirmMarshaller extends ListenerMarshaller implements ConfirmListener @@ -179,7 +179,7 @@ public class InvocationMarshaller } /** - * Defines a marshaller for the standard {@link InvocationService.ResultListener}. + * Defines a marshaller for the standard {@code InvocationService.ResultListener}. */ public static class ResultMarshaller extends ListenerMarshaller implements ResultListener diff --git a/src/main/java/com/threerings/presents/data/TimeBaseMarshaller.java b/src/main/java/com/threerings/presents/data/TimeBaseMarshaller.java index 5ec545372..af36f7b62 100644 --- a/src/main/java/com/threerings/presents/data/TimeBaseMarshaller.java +++ b/src/main/java/com/threerings/presents/data/TimeBaseMarshaller.java @@ -39,7 +39,7 @@ public class TimeBaseMarshaller extends InvocationMarshaller implements TimeBaseService { /** - * Marshalls results to implementations of {@link TimeBaseService.GotTimeBaseListener}. + * Marshalls results to implementations of {@code TimeBaseService.GotTimeBaseListener}. */ public static class GotTimeBaseMarshaller extends ListenerMarshaller implements GotTimeBaseListener diff --git a/src/main/java/com/threerings/presents/dobj/DSet.java b/src/main/java/com/threerings/presents/dobj/DSet.java index 0e09c45a3..82d5c49b7 100644 --- a/src/main/java/com/threerings/presents/dobj/DSet.java +++ b/src/main/java/com/threerings/presents/dobj/DSet.java @@ -277,7 +277,7 @@ public class DSet * the array argument is null, an object array of sufficient size to contain all * of the elements of this set will be created and returned. * - * @deprecated use {@link #clone} or add this to an {@link ArrayList}. Arrays are an untypesafe + * @deprecated use {@link #clone} or add this to an ArrayList. Arrays are an untypesafe * quagmire. */ @Deprecated @@ -292,7 +292,7 @@ public class DSet } /** - * @deprecated use {@link #clone} or add this to an {@link ArrayList}. Arrays are an untypesafe + * @deprecated use {@link #clone} or add this to an ArrayList. Arrays are an untypesafe * quagmire. */ @Deprecated diff --git a/src/main/java/com/threerings/presents/dobj/EntryEvent.java b/src/main/java/com/threerings/presents/dobj/EntryEvent.java index 72e3ee5ea..a9b2f6ee7 100644 --- a/src/main/java/com/threerings/presents/dobj/EntryEvent.java +++ b/src/main/java/com/threerings/presents/dobj/EntryEvent.java @@ -29,7 +29,10 @@ import com.threerings.presents.net.Transport; public abstract class EntryEvent extends NamedEvent { /** - * {@inheritDoc} + * Constructs a new event for the specified target object with the supplied attribute name. + * + * @param targetOid the object id of the object in question. + * @param name the name associated with this event. */ public EntryEvent (int targetOid, String name) { @@ -37,7 +40,11 @@ public abstract class EntryEvent extends NamedEvent } /** - * {@inheritDoc} + * Constructs a new event for the specified target object with the supplied attribute name. + * + * @param targetOid the object id of the object in question. + * @param name the name associated with this event. + * @param transport a hint as to the type of transport desired for the event. */ public EntryEvent (int targetOid, String name, Transport transport) { diff --git a/src/main/java/com/threerings/presents/server/InvocationManager.java b/src/main/java/com/threerings/presents/server/InvocationManager.java index 69b0b1c59..702dd7c90 100644 --- a/src/main/java/com/threerings/presents/server/InvocationManager.java +++ b/src/main/java/com/threerings/presents/server/InvocationManager.java @@ -245,9 +245,9 @@ public class InvocationManager } /** - * @Deprecated use {@link #registerDispatcher(InvocationDispatcher)}. + * @deprecated use {@link #registerDispatcher(InvocationDispatcher)}. */ - public T registerDispatcher ( + @Deprecated public T registerDispatcher ( InvocationDispatcher dispatcher, boolean bootstrap) { return registerDispatcher(dispatcher, null); diff --git a/src/main/java/com/threerings/presents/server/ShutdownManager.java b/src/main/java/com/threerings/presents/server/ShutdownManager.java index 1e017e899..f6dc38a94 100644 --- a/src/main/java/com/threerings/presents/server/ShutdownManager.java +++ b/src/main/java/com/threerings/presents/server/ShutdownManager.java @@ -29,9 +29,9 @@ import com.samskivert.util.Lifecycle; /** * Handles the orderly shutdown of all server services. * - * @Deprecated use Lifecycle + * @deprecated use Lifecycle */ -@Singleton +@Deprecated @Singleton public class ShutdownManager { /** Implementers of this interface will be notified when the server is shutting down. */ diff --git a/src/main/java/com/threerings/presents/server/net/PresentsConnection.java b/src/main/java/com/threerings/presents/server/net/PresentsConnection.java index 31818a106..b785833b4 100644 --- a/src/main/java/com/threerings/presents/server/net/PresentsConnection.java +++ b/src/main/java/com/threerings/presents/server/net/PresentsConnection.java @@ -50,7 +50,7 @@ import static com.threerings.presents.Log.log; */ public class PresentsConnection extends Connection { - /** Used with {@link Connection#setMessageHandler}. */ + /** Used with {@link #setMessageHandler}. */ public static interface MessageHandler { /** Called when a complete message has been parsed from incoming network data. */ void handleMessage (Message message); diff --git a/src/main/java/com/threerings/presents/util/InvocationAdapter.java b/src/main/java/com/threerings/presents/util/InvocationAdapter.java index 819b75301..90e4bf526 100644 --- a/src/main/java/com/threerings/presents/util/InvocationAdapter.java +++ b/src/main/java/com/threerings/presents/util/InvocationAdapter.java @@ -27,7 +27,7 @@ import com.threerings.presents.client.InvocationService; import com.threerings.presents.server.InvocationException; /** - * Adapts the response from a {@link InvocationService.ResultListener} to a {@link ResultListener}. + * Adapts the response from a {@code InvocationService.ResultListener} to a {@link ResultListener}. * In the event of failure, the failure string is wrapped in an {@link InvocationException}. */ public class InvocationAdapter implements InvocationService.ResultListener diff --git a/src/main/java/com/threerings/presents/util/PersistingUnit.java b/src/main/java/com/threerings/presents/util/PersistingUnit.java index 9a68663bb..f85eaf145 100644 --- a/src/main/java/com/threerings/presents/util/PersistingUnit.java +++ b/src/main/java/com/threerings/presents/util/PersistingUnit.java @@ -32,7 +32,7 @@ import static com.threerings.presents.Log.log; /** * Simplifies a common pattern which is to post an {@link Invoker} unit which does some database - * operation and then calls back to an {@link InvocationService.InvocationListener} of some + * operation and then calls back to an {@code InvocationService.InvocationListener} of some * sort. If the database operation fails, the error will be logged and the result listener will be * replied to with {@link InvocationCodes#INTERNAL_ERROR}. */ diff --git a/src/main/resources/com/threerings/presents/tools/marshaller.tmpl b/src/main/resources/com/threerings/presents/tools/marshaller.tmpl index 8ab71d1d1..1c55e56fa 100644 --- a/src/main/resources/com/threerings/presents/tools/marshaller.tmpl +++ b/src/main/resources/com/threerings/presents/tools/marshaller.tmpl @@ -19,7 +19,7 @@ public class {{name}}Marshaller extends InvocationMarshaller { {{#listeners}} /** - * Marshalls results to implementations of {@code {{name}}Service#{{listenerName}}Listener}. + * Marshalls results to implementations of {@code {{name}}Service.{{listenerName}}Listener}. */ public static class {{listenerName}}Marshaller extends ListenerMarshaller implements {{listenerName}}Listener diff --git a/src/test/java/com/threerings/bureau/server/RegistryTester.java b/src/test/java/com/threerings/bureau/server/RegistryTester.java index 0b22bc83c..f1bfdc84b 100644 --- a/src/test/java/com/threerings/bureau/server/RegistryTester.java +++ b/src/test/java/com/threerings/bureau/server/RegistryTester.java @@ -31,9 +31,10 @@ import com.google.inject.Inject; import com.google.inject.Injector; import com.google.inject.Singleton; +import com.samskivert.util.Lifecycle; + import com.threerings.presents.dobj.RootDObjectManager; import com.threerings.presents.server.PresentsSession; -import com.threerings.presents.server.ShutdownManager; import com.threerings.bureau.data.AgentObject; import com.threerings.bureau.data.BureauCredentials; @@ -87,7 +88,7 @@ public class RegistryTester /** * Creates a new registry tester. */ - @Inject public RegistryTester (TestServer server, ShutdownManager shutmgr) + @Inject public RegistryTester (TestServer server, Lifecycle cycle) { _server = server; @@ -105,7 +106,7 @@ public class RegistryTester // stop the tests when the server shuts down // TODO: this is not called on Ctrl-C, need a way to shut down gracefully - shutmgr.registerShutdowner(new ShutdownManager.Shutdowner() { + cycle.addComponent(new Lifecycle.ShutdownComponent() { public void shutdown () { log.info("Shutting down tests"); _stop = true; diff --git a/src/test/java/com/threerings/presents/data/TestMarshaller.java b/src/test/java/com/threerings/presents/data/TestMarshaller.java index a61427fb4..b572cfe7d 100644 --- a/src/test/java/com/threerings/presents/data/TestMarshaller.java +++ b/src/test/java/com/threerings/presents/data/TestMarshaller.java @@ -41,7 +41,7 @@ public class TestMarshaller extends InvocationMarshaller implements TestService { /** - * Marshalls results to implementations of {@link TestService.TestFuncListener}. + * Marshalls results to implementations of {@code TestService.TestFuncListener}. */ public static class TestFuncMarshaller extends ListenerMarshaller implements TestFuncListener @@ -76,7 +76,7 @@ public class TestMarshaller extends InvocationMarshaller } /** - * Marshalls results to implementations of {@link TestService.TestOidListener}. + * Marshalls results to implementations of {@code TestService.TestOidListener}. */ public static class TestOidMarshaller extends ListenerMarshaller implements TestOidListener