From 8493c455fbdfc81064775d33ef02a9339a8755a7 Mon Sep 17 00:00:00 2001 From: Michael Bayne Date: Thu, 12 Mar 2015 11:41:06 -0700 Subject: [PATCH] Various javadoc fixes. --- .../admin/client/TabbedDSetEditor.java | 4 ---- .../presents/client/InvocationService.java | 10 +++++----- .../presents/server/net/AuthingConnection.java | 2 +- .../java/com/threerings/util/Resulting.java | 18 +++++++++--------- .../presents/peer/server/PeerTestGroup.java | 2 +- pom.xml | 5 +++-- .../presents/tools/GenServiceTask.java | 14 +++++++------- 7 files changed, 26 insertions(+), 29 deletions(-) diff --git a/core/src/main/java/com/threerings/admin/client/TabbedDSetEditor.java b/core/src/main/java/com/threerings/admin/client/TabbedDSetEditor.java index 28fd07cf6..853338003 100644 --- a/core/src/main/java/com/threerings/admin/client/TabbedDSetEditor.java +++ b/core/src/main/java/com/threerings/admin/client/TabbedDSetEditor.java @@ -92,10 +92,6 @@ public class TabbedDSetEditor extends JPanel }; } - /** - * Grinds through the - * @param entries - */ public void computeGroups (Iterable entries) { for (E entry : entries) { String[] groups = computeGroups(entry); diff --git a/core/src/main/java/com/threerings/presents/client/InvocationService.java b/core/src/main/java/com/threerings/presents/client/InvocationService.java index d2498cf3f..f4a9f9cff 100644 --- a/core/src/main/java/com/threerings/presents/client/InvocationService.java +++ b/core/src/main/java/com/threerings/presents/client/InvocationService.java @@ -28,8 +28,8 @@ import com.threerings.presents.data.ClientObject; * extending this interface and defining service methods, as well as response listeners (which must * extend {@link InvocationListener}). For example: * - *
- * public interface LocationService extends InvocationService<ClientObject>
+ * 
{@code
+ * public interface LocationService extends InvocationService
  * {
  *
  *     // Used to communicate responses to moveTo() requests.
@@ -45,13 +45,13 @@ import com.threerings.presents.data.ClientObject;
  *     // @param listener the listener that will be informed of success or failure.
  *     void moveTo (int placeId, MoveListener listener);
  * }
- * 
+ * }
* * From this interface, a LocationProvider interface will be generated which should be * implemented by whatever server entity that will actually provide the server side of this * invocation service. That provider interface would look like the following: * - *
+ * 
{@code
  * public interface LocationProvider extends InvocationProvider
  * {
  *      // Requests that this client's body be moved to the specified location.
@@ -62,7 +62,7 @@ import com.threerings.presents.data.ClientObject;
  *     void moveTo (ClientObject caller, int placeId, MoveListener listener)
  *         throws InvocationException;
  * }
- * 
+ * }
*/ public interface InvocationService { diff --git a/core/src/main/java/com/threerings/presents/server/net/AuthingConnection.java b/core/src/main/java/com/threerings/presents/server/net/AuthingConnection.java index adb814e63..1ea7be1d1 100644 --- a/core/src/main/java/com/threerings/presents/server/net/AuthingConnection.java +++ b/core/src/main/java/com/threerings/presents/server/net/AuthingConnection.java @@ -135,7 +135,7 @@ public class AuthingConnection extends PresentsConnection /** * Returns the username that uniquely identifies this authenticated session. This will be used - * to map Name -> PresentsSession in the ClientManager and used elsewhere. + * to map {@code Name -> PresentsSession} in the {@code ClientManager} and used elsewhere. */ public Name getAuthName () { diff --git a/core/src/main/java/com/threerings/util/Resulting.java b/core/src/main/java/com/threerings/util/Resulting.java index c348d2327..9e6e6a7c9 100644 --- a/core/src/main/java/com/threerings/util/Resulting.java +++ b/core/src/main/java/com/threerings/util/Resulting.java @@ -45,13 +45,13 @@ public class Resulting extends Invoker.Unit implements ResultListener, InvocationService.ConfirmListener, InvocationService.ResultListener { - /** A handy Object->Void function for when you wish to chain to a ResultListener. */ - public static final Function TO_VOID = - new Function() { - public Void apply (Object o) { - return null; - } - }; + /** A handy {@code Object -> Void} function for when you wish to chain to a + * {@code ResultListener}. */ + public static final Function TO_VOID = new Function() { + public Void apply (Object o) { + return null; + } + }; public Resulting (String name) { @@ -116,8 +116,8 @@ public class Resulting extends Invoker.Unit } /** - * Construct your Resulting, overriding what you need to, - * then call this to adapt it. + * Construct your {@code Resulting}, overriding what you need to, then call this to + * adapt it. */ public final IntResultListener asIntResultListener () { diff --git a/core/src/test/java/com/threerings/presents/peer/server/PeerTestGroup.java b/core/src/test/java/com/threerings/presents/peer/server/PeerTestGroup.java index 6c9217901..079484ab2 100644 --- a/core/src/test/java/com/threerings/presents/peer/server/PeerTestGroup.java +++ b/core/src/test/java/com/threerings/presents/peer/server/PeerTestGroup.java @@ -33,7 +33,7 @@ import com.google.inject.Inject; import com.google.inject.Injector; import com.samskivert.depot.PersistenceContext; -import com.samskivert.jdbc.StaticConnectionProvider; +import com.samskivert.depot.StaticConnectionProvider; import com.threerings.presents.server.PresentsServer; diff --git a/pom.xml b/pom.xml index db6d8b9ff..f4194e2ee 100644 --- a/pom.xml +++ b/pom.xml @@ -77,13 +77,14 @@ org.apache.maven.plugins maven-javadoc-plugin - 2.7 + 2.9.1 true public + -Xdoclint:all -Xdoclint:-missing http://samskivert.github.com/samskivert/apidocs/ - http://depot.googlecode.com/svn/apidocs/ + http://threerings.github.io/depot/apidocs/ http://docs.guava-libraries.googlecode.com/git/javadoc/ http://google-web-toolkit.googlecode.com/svn/javadoc/latest/ http://www.jajakarta.org/ant/ant-1.6.1/docs/ja/manual/api/ diff --git a/tools/src/main/java/com/threerings/presents/tools/GenServiceTask.java b/tools/src/main/java/com/threerings/presents/tools/GenServiceTask.java index 7eeaf01a3..1ee4f575a 100644 --- a/tools/src/main/java/com/threerings/presents/tools/GenServiceTask.java +++ b/tools/src/main/java/com/threerings/presents/tools/GenServiceTask.java @@ -49,13 +49,13 @@ import com.threerings.presents.server.InvocationException; import com.threerings.presents.server.InvocationProvider; /** - * An Ant task for generating invocation service marshalling and - * unmarshalling classes. - * TODO: when generating the imports for exported action script files, there are just enough - * conversions of primitive types (e.g. float -> Number), array types (e.g. int[] -> TypedArray) - * and three rings utility types (e.g. float -> Float) to make the existing serivces work. It - * should be possible to create a complete list of these conversions so that future services - * can be generated without problems. + * An Ant task for generating invocation service marshalling and unmarshalling classes. + * + *

TODO: when generating the imports for exported action script files, there are just enough + * conversions of primitive types (e.g. {@code float -> Number}), array types (e.g. {@code int[] -> + * TypedArray}) and three rings utility types (e.g. {@code float -> Float}) to make the existing + * serivces work. It should be possible to create a complete list of these conversions so that + * future services can be generated without problems. */ public class GenServiceTask extends InvocationTask {