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
@@ -864,7 +864,7 @@ public class ChatDirector extends BasicDirector
return buf.toString();
}
/** Helper function for {@link #mogrifyChat}. */
/** Helper function for {@link #mogrifyChat(String,boolean,boolean)}. */
protected StringBuffer mogrifyChat (
StringBuffer buf, boolean transformsAllowed, boolean capFirst)
{
@@ -1152,9 +1152,9 @@ public class ChatDirector extends BasicDirector
Object[] commands = possibleCommands.keySet().toArray();
Arrays.sort(commands);
String commandList = "";
for (int ii = 0; ii < commands.length; ii++) {
commandList += " /" + commands[ii];
}
for (Object element : commands) {
commandList += " /" + element;
}
return MessageBundle.tcompose("m.usage_help", commandList);
}
}
@@ -36,17 +36,16 @@ import com.threerings.presents.client.InvocationService;
public interface ChatService extends InvocationService
{
/**
* Used to communicate the response to a {@link #tell} request.
* Used to communicate the response to a {@link ChatService#tell} request.
*/
public static interface TellListener extends InvocationListener
{
/**
* Communicates the response to a {@link #tell} request.
* Communicates the response to a {@link ChatService#tell} request.
*
* @param idleTime the number of ms the tellee has been idle or 0L
* if they are not idle.
* @param awayMessage the away message configured by the told
* player or null if they have no away message.
* @param idleTime the number of ms the tellee has been idle or 0L if they are not idle.
* @param awayMessage the away message configured by the told player or null if they have
* no away message.
*/
void tellSucceeded (long idleTime, String awayMessage);
}
@@ -56,8 +55,7 @@ public interface ChatService extends InvocationService
* equal to <code>target</code>.
*
* @param client a connected, operational client instance.
* @param target the username of the user to which the tell message
* should be delivered.
* @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.
*/
@@ -29,7 +29,7 @@ import com.threerings.util.Name;
*/
public interface SpeakObject
{
/** Used in conjunction with {@link #applyToListeners}. */
/** Used in conjunction with {@link SpeakObject#applyToListeners}. */
public static interface ListenerOp
{
/** Call this method if you only have access to body oids. */
@@ -34,12 +34,12 @@ import com.threerings.crowd.data.PlaceConfig;
public interface LocationService extends InvocationService
{
/**
* Used to communicate responses to {@link #moveTo} requests.
* Used to communicate responses to {@link LocationService#moveTo} requests.
*/
public static interface MoveListener extends InvocationListener
{
/**
* Called in response to a successful {@link #moveTo} request.
* Called in response to a successful {@link LocationService#moveTo} request.
*/
void moveSucceeded (PlaceConfig config);
}
@@ -41,7 +41,7 @@ import static com.threerings.crowd.Log.log;
public class BodyManager
implements BodyProvider
{
/** Used by {@link #updateOccupantInfo}. */
/** Used by {@link BodyManager#updateOccupantInfo}. */
public static interface OccupantInfoOp
{
/**
@@ -50,7 +50,7 @@ import static com.threerings.crowd.Log.log;
public class PlaceRegistry
implements ShutdownManager.Shutdowner
{
/** Used in conjunction with {@link #createPlace}. */
/** Used in conjunction with {@link PlaceRegistry#createPlace(PlaceConfig,PreStartupHook)}. */
public static interface PreStartupHook
{
void invoke (PlaceManager plmgr);