AfflictionNetworks/narya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Javadoc warnings cleanups.

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
src/java/com/threerings/presents/client/Client.java
+7 -6
View File
@@ -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 (
src/java/com/threerings/presents/client/ClientObserver.java
+8 -7
View File
@@ -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);
src/java/com/threerings/presents/client/TimeBaseService.java
+2 -2
View File
@@ -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);
}
src/java/com/threerings/presents/data/ClientObject.java
+4 -4
View File
@@ -82,8 +82,8 @@ public class ClientObject extends DObject
}
/**
* Convenience wrapper around {@link #checkAccess} that simply returns a boolean indicating
* whether or not this client has the permission rather than an explanation.
* Convenience wrapper around {@link #checkAccess(Permission,Object)} that simply returns a
* boolean indicating whether or not this client has the permission rather than an explanation.
*/
public boolean hasAccess (Permission perm, Object context)
{
@@ -91,8 +91,8 @@ public class ClientObject extends DObject
}
/**
* Convenience wrapper around {@link #checkAccess} that simply returns a boolean indicating
* whether or not this client has the permission rather than an explanation.
* Convenience wrapper around {@link #checkAccess(Permission)} that simply returns a boolean
* indicating whether or not this client has the permission rather than an explanation.
*/
public boolean hasAccess (Permission perm)
{
src/java/com/threerings/presents/data/Permission.java
+2 -1
View File
@@ -22,7 +22,8 @@
package com.threerings.presents.data;
/**
* A value class used by {@link ClientObject#checkAccess} to do fine-grained access control.
* A value class used by {@link ClientObject#checkAccess(Permission)} to do fine-grained access
* control.
*/
public class Permission
{
src/java/com/threerings/presents/peer/server/PeerManager.java
+1 -1
View File
@@ -108,7 +108,7 @@ public abstract class PeerManager
/**
* Wraps an operation that needs a shared resource lock to be acquired before it can be
* performed, and released after it completes. Used by {@link #performWithLock}.
* performed, and released after it completes. Used by {@link PeerManager#performWithLock}.
*/
public static interface LockedOperation
{
src/java/com/threerings/presents/peer/server/persist/NodeRecord.java
+1 -1
View File
@@ -127,7 +127,7 @@ public class NodeRecord extends PersistentRecord
// AUTO-GENERATED: METHODS START
/**
* Create and return a primary {@link Key} to identify a {@link #NodeRecord}
* Create and return a primary {@link Key} to identify a {@link NodeRecord}
* with the supplied key values.
*/
public static Key<NodeRecord> getKey (String nodeName)
src/java/com/threerings/presents/server/ClientManager.java
+2 -2
View File
@@ -64,7 +64,7 @@ public class ClientManager
ReportManager.Reporter, ShutdownManager.Shutdowner
{
/**
* Used by {@link #applyToClient}.
* Used by {@link ClientManager#applyToClient}.
*/
public static interface ClientOp
{
@@ -519,7 +519,7 @@ public class ClientManager
}
}
/** Used by {@link #applyToClient}. */
/** Used by {@link ClientManager#applyToClient}. */
protected class ClientOpResolver
implements ClientResolutionListener
{
src/java/com/threerings/presents/server/InvocationException.java
+3 -5
View File
@@ -46,7 +46,7 @@ public class InvocationException extends Exception
}
/**
* A version of {@link #requireAccess} that takes no context.
* A version of {@link #requireAccess(ClientObject,Permission,Object)} that takes no context.
*/
public static void requireAccess (ClientObject clobj, Permission perm)
throws InvocationException
@@ -55,8 +55,7 @@ public class InvocationException extends Exception
}
/**
* Constructs an invocation exception with the supplied cause code
* string.
* Constructs an invocation exception with the supplied cause code string.
*/
public InvocationException (String cause)
{
@@ -66,8 +65,7 @@ public class InvocationException extends Exception
/**
* Constructs an invocation exception with the supplied cause code
* string and qualifying message bundle. The error code will be
* qualified with the message bundle (see {@link
* MessageBundle#qualify}).
* qualified with the message bundle (see {@link MessageBundle#qualify}).
*/
public InvocationException (String bundle, String code)
{
src/java/com/threerings/presents/server/PresentsClient.java
+1 -1
View File
@@ -82,7 +82,7 @@ import static com.threerings.presents.Log.log;
public class PresentsClient
implements MessageHandler, ClientResolutionListener
{
/** Used by {@link #setUsername} to report success or failure. */
/** Used by {@link PresentsClient#setUsername} to report success or failure. */
public static interface UserChangeListener
{
/** Called when the new client object has been resolved and the new client object reported
src/java/com/threerings/presents/server/ReportManager.java
+5 -2
View File
@@ -38,7 +38,10 @@ import static com.threerings.presents.Log.log;
@Singleton
public class ReportManager
{
/** Used to generate "state of the server" reports. See {@link #registerReporter}. */
/**
* Used to generate "state of the server" reports.
* See {@link ReportManager#registerReporter}.
* */
public static interface Reporter
{
/**
@@ -155,7 +158,7 @@ public class ReportManager
/** The time at which the server was started. */
protected long _serverStartTime = System.currentTimeMillis();
/** The last time at which {@link #generateReport} was run. */
/** The last time at which {@link #generateReport(long,boolean)} was run. */
protected long _lastReportStamp = _serverStartTime;
/** Used to generate "state of server" reports. */
src/java/com/threerings/presents/server/ShutdownManager.java
+1 -1
View File
@@ -47,7 +47,7 @@ public class ShutdownManager
void shutdown ();
}
/** Constraints for use with {@link #addConstraint}. */
/** Constraints for use with {@link ShutdownManager#addConstraint}. */
public static enum Constraint { RUNS_BEFORE, RUNS_AFTER };
@Inject ShutdownManager (@EventQueue RunQueue dobjq)
src/java/com/threerings/presents/server/net/ConnectionManager.java
+4 -5
View File
@@ -284,21 +284,20 @@ public class ConnectionManager extends LoopingThread
{
int successes = 0;
IOException failure = null;
for (int ii = 0; ii < _ports.length; ii++) {
for (int port : _ports) {
try {
// create a listening socket and add it to the select set
_ssocket = ServerSocketChannel.open();
_ssocket.configureBlocking(false);
InetSocketAddress isa = new InetSocketAddress(_ports[ii]);
InetSocketAddress isa = new InetSocketAddress(port);
_ssocket.socket().bind(isa);
registerChannel(_ssocket);
successes++;
log.info("Server listening on " + isa + ".");
} catch (IOException ioe) {
log.warning("Failure listening to socket on port '" +
_ports[ii] + "'.", ioe);
log.warning("Failure listening to socket on port '" + port + "'.", ioe);
failure = ioe;
}
}
@@ -940,7 +939,7 @@ public class ConnectionManager extends LoopingThread
notifyObservers(CONNECTION_CLOSED, conn, null, null);
}
/** Used to handle partial writes in {@link #writeMessage}. */
/** Used to handle partial writes in {@link ConnectionManager#writeMessage}. */
protected static interface PartialWriteHandler
{
void handlePartialWrite (Connection conn, ByteBuffer buffer);