Added method comments to newly created methods.

git-svn-id: http://svn.igniterealtime.org/svn/repos/messenger/trunk@548 b35dd754-fafc-0310-a699-88a17e54d16e

src/java/org/jivesoftware/messenger/muc/MultiUserChatServer.java

@@ -103,20 +103,76 @@ public interface MultiUserChatServer {
      */
     void removeUserAllowedToCreate(String userJID);
 
+    /**
+     * Sets the time to elapse between clearing of idle chat users. A <code>TimerTask</code> will be
+     * added to a <code>Timer</code> scheduled for repeated fixed-delay execution whose main
+     * responsibility is to kick users that have been idle for a certain time. A user is considered
+     * idle if he/she didn't send any message to any group chat room for a certain amount of time.
+     * See {@link #setUserIdleTime(int)}.
+     *
+     * @param timeout the time to elapse between clearing of idle chat users.
+     */
     void setKickIdleUsersTimeout(int timeout);
 
+    /**
+     * Returns the time to elapse between clearing of idle chat users. A user is considered
+     * idle if he/she didn't send any message to any group chat room for a certain amount of time.
+     * See {@link #getUserIdleTime()}.
+     *
+     * @return the time to elapse between clearing of idle chat users.
+     */
     int getKickIdleUsersTimeout();
 
+    /**
+     * Sets the number of milliseconds a user must be idle before he/she gets kicked from all
+     * the rooms. By idle we mean that the user didn't send any message to any group chat room.
+     *
+     * @param idle the amount of time to wait before considering a user idle.
+     */
     void setUserIdleTime(int idle);
 
+    /**
+     * Returns the number of milliseconds a user must be idle before he/she gets kicked from all
+     * the rooms. By idle we mean that the user didn't send any message to any group chat room.
+     *
+     * @return the amount of time to wait before considering a user idle.
+     */
     int getUserIdleTime();
 
+    /**
+     * Sets the time to elapse between logging the room conversations. A <code>TimerTask</code> will
+     * be added to a <code>Timer</code> scheduled for repeated fixed-delay execution whose main
+     * responsibility is to log queued rooms conversations. The number of queued conversations to
+     * save on each run can be configured. See {@link #setLogConversationBatchSize(int)}.
+     *
+     * @param timeout the time to elapse between logging the room conversations.
+     */
     void setLogConversationsTimeout(int timeout);
 
+    /**
+     * Returns the time to elapse between logging the room conversations. A <code>TimerTask</code>
+     * will be added to a <code>Timer</code> scheduled for repeated fixed-delay execution whose main
+     * responsibility is to log queued rooms conversations. The number of queued conversations to
+     * save on each run can be configured. See {@link #getLogConversationBatchSize()}.
+     *
+     * @return the time to elapse between logging the room conversations.
+     */
     int getLogConversationsTimeout();
 
+    /**
+     * Sets the number of messages to save to the database on each run of the logging process.
+     * Even though the saving of queued conversations takes place in another thread it is not
+     * recommended specifying a big number.
+     *
+     * @param size the number of messages to save to the database on each run of the logging process.
+     */
     void setLogConversationBatchSize(int size);
 
+    /**
+     * Returns the number of messages to save to the database on each run of the logging process.
+     *
+     * @return the number of messages to save to the database on each run of the logging process.
+     */
     int getLogConversationBatchSize();
 
     /**