Javadoc warnings cleanups.

Note: this involves generated code from a samskivert patch I only just sent to mdb,
but he's in a meeting, so that won't show up for a little.


git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@5369 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Dave Hoover
2008-09-12 17:59:26 +00:00
parent 8114439855
commit 7ee6ace683
27 changed files with 87 additions and 92 deletions
@@ -21,6 +21,8 @@
package com.threerings.presents.client;
import static com.threerings.presents.Log.log;
import java.util.HashSet;
import com.samskivert.util.Interval;
@@ -28,7 +30,7 @@ import com.samskivert.util.ObserverList;
import com.samskivert.util.RunAnywhere;
import com.samskivert.util.RunQueue;
import com.samskivert.util.StringUtil;
import com.threerings.presents.client.InvocationService.ConfirmListener;
import com.threerings.presents.data.AuthCodes;
import com.threerings.presents.data.ClientObject;
import com.threerings.presents.data.InvocationCodes;
@@ -41,8 +43,6 @@ import com.threerings.presents.net.Credentials;
import com.threerings.presents.net.PingRequest;
import com.threerings.presents.net.PongResponse;
import static com.threerings.presents.Log.log;
/**
* Through the client object, a connection to the system is established and maintained. The client
* object maintains two separate threads (a reader and a writer) by which all network traffic is
@@ -117,7 +117,7 @@ public class Client
* ports (which will be tried in succession).
*
* @see #logon
* @see #moveToServer
* @see #moveToServer(String,int[],ConfirmListener)
*/
public void setServer (String hostname, int[] ports)
{
@@ -129,7 +129,7 @@ public class Client
* ports (which will be tried in succession), and datagram ports.
*
* @see #logon
* @see #moveToServer
* @see #moveToServer(String,int[],ConfirmListener)
*/
public void setServer (String hostname, int[] ports, int[] datagramPorts)
{
@@ -894,7 +894,8 @@ public class Client
protected boolean _rejected;
}
/** Handles the process of switching between servers. See {@link #moveToServer}. */
/** Handles the process of switching between servers.
* See {@link Client#moveToServer(String,int[],int[],ConfirmListener)}. */
protected class ServerSwitcher extends ClientAdapter
{
public ServerSwitcher (
@@ -25,10 +25,10 @@ package com.threerings.presents.client;
* A client observer is a more detailed version of the {@link SessionObserver} for entities that
* are interested in more detail about the logon/logoff process.
*
* <p> In the normal course of affairs, {@link #clientDidLogon} will be called after the client
* successfully logs on to the server and {@link #clientDidLogoff} will be called after the client
* logs off of the server. If logon fails for any reson, {@link #clientFailedToLogon} will be
* called to explain the failure.
* <p> In the normal course of affairs, {@link SessionObserver#clientDidLogon} will be called after
* the client successfully logs on to the server and {@link SessionObserver#clientDidLogoff} will
* be called after the client logs off of the server. If logon fails for any reason,
* {@link #clientFailedToLogon} will be called to explain the failure.
*
* <p> {@link #clientWillLogoff} will only be called when an abortable logoff is requested (like
* when the user clicks on a logoff button of some sort). It will not be called during
@@ -38,8 +38,9 @@ package com.threerings.presents.client;
* calls {@link #clientWillLogoff}</em>).
*
* <p> If the client connection fails unexpectedly, {@link #clientConnectionFailed} will be called
* to let the observers know that we lost our connection to the server. {@link #clientDidLogoff}
* will be called immediately afterwards as a normal logoff procedure is effected.
* to let the observers know that we lost our connection to the server.
* {@link SessionObserver#clientDidLogoff} will be called immediately afterwards as a normal logoff
* procedure is effected.
*/
public interface ClientObserver extends SessionObserver
{
@@ -58,7 +59,7 @@ public interface ClientObserver extends SessionObserver
/**
* Called when the connection to the server went away for some unexpected reason. This will be
* followed by a call to {@link #clientDidLogoff}.
* followed by a call to {@link SessionObserver#clientDidLogoff}.
*/
void clientConnectionFailed (Client client, Exception cause);
@@ -28,12 +28,12 @@ package com.threerings.presents.client;
public interface TimeBaseService extends InvocationService
{
/**
* Used to communicated the result of a {@link #getTimeOid} request.
* Used to communicated the result of a {@link TimeBaseService#getTimeOid} request.
*/
public static interface GotTimeBaseListener extends InvocationListener
{
/**
* Communicates the result of a successful {@link #getTimeOid} request.
* Communicates the result of a successful {@link TimeBaseService#getTimeOid} request.
*/
void gotTimeOid (int timeOid);
}