From 2dcdebc29ba64de6b8982c08c5e175eac56e3c93 Mon Sep 17 00:00:00 2001
From: Michael Bayne <mdb@threerings.net>
Date: Wed, 19 Jul 2006 00:45:51 +0000
Subject: [PATCH] Document the messages broadcast to the server.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@4277 542714f4-19e9-0310-aa3c-eee0fc999fb1
---
 src/java/com/threerings/presents/server/RebootManager.java | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/java/com/threerings/presents/server/RebootManager.java b/src/java/com/threerings/presents/server/RebootManager.java
index e4bb1bfdf..f360a7813 100644
--- a/src/java/com/threerings/presents/server/RebootManager.java
+++ b/src/java/com/threerings/presents/server/RebootManager.java
@@ -188,7 +188,12 @@ public abstract class RebootManager
     }
 
     /**
-     * Broadcasts a message to everyone on the server.
+     * Broadcasts a message to everyone on the server. The following
+     * messages will be broadcast:
+     * <ul><li> m.rebooting_now
+     *     <li> m.reboot_warning (minutes) (message or m.reboot_msg_standard)
+     *     <li> m.reboot_delayed
+     * </ul>
      */
     protected abstract void broadcast (String message);