Added a comment about possible return values.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3692 542714f4-19e9-0310-aa3c-eee0fc999fb1
2005-08-29 21:42:11 +00:00
parent 91576fcfd3
commit d5ec5675d7
1 changed files with 2 additions and 1 deletions
@@ -743,7 +743,8 @@ public class ChatDirector extends BasicDirector
     * chat message. Derived classes may wish to throttle chat or restrict
     * certain types in certain circumstances for whatever reason.
     *
-     * @return null if the chat is permitted, a translatable string
+     * @return null if the chat is permitted, SUCCESS if the chat is permitted
+     * and has already been dealt with, or a translatable string
     * indicating the reason for rejection if not.
     */
    protected String checkCanChat (