Various javadoc fixes.

This commit is contained in:
Michael Bayne
2015-03-12 11:41:06 -07:00
parent 05c6374264
commit 8493c455fb
7 changed files with 26 additions and 29 deletions
@@ -92,10 +92,6 @@ public class TabbedDSetEditor<E extends DSet.Entry> extends JPanel
};
}
/**
* Grinds through the
* @param entries
*/
public void computeGroups (Iterable<E> entries) {
for (E entry : entries) {
String[] groups = computeGroups(entry);
@@ -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:
*
* <pre>
* public interface LocationService extends InvocationService&lt;ClientObject>
* <pre>{@code
* public interface LocationService extends InvocationService<ClientObject>
* {
*
* // 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);
* }
* </pre>
* }</pre>
*
* From this interface, a <code>LocationProvider</code> 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:
*
* <pre>
* <pre>{@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;
* }
* </pre>
* }</pre>
*/
public interface InvocationService<T extends ClientObject>
{
@@ -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 ()
{
@@ -45,13 +45,13 @@ public class Resulting<T> extends Invoker.Unit
implements ResultListener<T>,
InvocationService.ConfirmListener, InvocationService.ResultListener
{
/** A handy Object->Void function for when you wish to chain to a ResultListener<Void>. */
public static final Function<Object, Void> TO_VOID =
new Function<Object, Void>() {
public Void apply (Object o) {
return null;
}
};
/** A handy {@code Object -> Void} function for when you wish to chain to a
* {@code ResultListener<Void>}. */
public static final Function<Object, Void> TO_VOID = new Function<Object, Void>() {
public Void apply (Object o) {
return null;
}
};
public Resulting (String name)
{
@@ -116,8 +116,8 @@ public class Resulting<T> extends Invoker.Unit
}
/**
* Construct your Resulting<Integer>, overriding what you need to,
* then call this to adapt it.
* Construct your {@code Resulting<Integer>}, overriding what you need to, then call this to
* adapt it.
*/
public final IntResultListener asIntResultListener ()
{
@@ -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;
+3 -2
View File
@@ -77,13 +77,14 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.7</version>
<version>2.9.1</version>
<configuration>
<quiet>true</quiet>
<show>public</show>
<additionalparam>-Xdoclint:all -Xdoclint:-missing</additionalparam>
<links>
<link>http://samskivert.github.com/samskivert/apidocs/</link>
<link>http://depot.googlecode.com/svn/apidocs/</link>
<link>http://threerings.github.io/depot/apidocs/</link>
<link>http://docs.guava-libraries.googlecode.com/git/javadoc/</link>
<link>http://google-web-toolkit.googlecode.com/svn/javadoc/latest/</link>
<link>http://www.jajakarta.org/ant/ant-1.6.1/docs/ja/manual/api/</link>
@@ -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.
*
* <p>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
{