Big fat Bernie javadoc cleanup.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3310 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Michael Bayne
2005-01-24 23:08:21 +00:00
parent dd04679568
commit afabea71ad
65 changed files with 158 additions and 132 deletions
@@ -313,7 +313,7 @@ public class ChatDirector extends BasicDirector
* Requests that a speak message with the specified mode be generated
* and delivered via the supplied speak service instance (which will
* be associated with a particular "speak object"). The message will
* first be validated by all registered {@link ChatValidator}s (and
* first be validated by all registered {@link ChatFilter}s (and
* possibly vetoed) before being dispatched.
*
* @param speakService the speak service to use when generating the
@@ -366,7 +366,7 @@ public class ChatDirector extends BasicDirector
*
* @param target the username of the user to which the tell message
* should be delivered.
* @param message the contents of the tell message.
* @param msg the contents of the tell message.
* @param rl an optional result listener if you'd like to be notified
* of success or failure.
*/
@@ -1,5 +1,5 @@
//
// $Id: ChatService.java,v 1.14 2004/08/27 02:12:30 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -43,7 +43,7 @@ public interface ChatService extends InvocationService
/**
* Communicates the response to a {@link #tell} request.
*
* @param idletime the number of ms the tellee has been idle or 0L
* @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.
@@ -1,5 +1,5 @@
//
// $Id: ChatCodes.java,v 1.20 2004/08/27 02:12:31 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -23,6 +23,9 @@ package com.threerings.crowd.chat.data;
import com.threerings.presents.data.InvocationCodes;
import com.threerings.crowd.chat.client.ChatDirector;
import com.threerings.crowd.chat.client.SpeakService;
/**
* Contains codes used by the chat invocation services.
*/
@@ -44,6 +44,7 @@ import com.threerings.crowd.server.AccessControl;
import com.threerings.crowd.server.CrowdServer;
import com.threerings.crowd.chat.client.ChatService.TellListener;
import com.threerings.crowd.chat.client.ChatService;
import com.threerings.crowd.chat.data.ChatCodes;
import com.threerings.crowd.chat.data.UserMessage;
@@ -160,7 +161,7 @@ public class ChatProvider
}
/**
* Processes a {@link ClientService#broadcast} request.
* Processes a {@link ChatService#broadcast} request.
*/
public void broadcast (ClientObject caller, String message,
InvocationListener listener)
@@ -223,7 +224,7 @@ public class ChatProvider
}
/**
* Processes a {@link ClientService#away} request.
* Processes a {@link ChatService#away} request.
*/
public void away (ClientObject caller, String message)
{
@@ -35,6 +35,7 @@ import com.threerings.crowd.Log;
import com.threerings.crowd.data.BodyObject;
import com.threerings.crowd.server.CrowdServer;
import com.threerings.crowd.chat.client.SpeakService;
import com.threerings.crowd.chat.data.ChatCodes;
import com.threerings.crowd.chat.data.ChatMessage;
import com.threerings.crowd.chat.data.SpeakObject;
@@ -25,6 +25,9 @@ import com.samskivert.util.StringUtil;
import com.threerings.io.TrackedStreamableObject;
import com.threerings.crowd.client.LocationDirector;
import com.threerings.crowd.client.PlaceController;
/**
* The place config class encapsulates the configuration information for a
* particular type of place. The hierarchy of place config objects mimics