Updated class comments.

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

src/java/org/jivesoftware/messenger/XMPPServer.java

@@ -58,8 +58,22 @@ import java.sql.SQLException;
  * through the server. The server maintains a list of loaded modules.<p>
  *
  * After starting up all the modules the server will load any available plugin.
- * For more information see: {@link org.jivesoftware.messenger.container.PluginManager}.
- * </p>
+ * For more information see: {@link org.jivesoftware.messenger.container.PluginManager}.<p>
+ *
+ * A configuration file keeps the server configuration. This information is required for the
+ * server to work correctly. The server assumes that the configuration file is named
+ * <b>jive-messenger.xml</b> and is located in the <b>conf</b> folder. The folder that keeps
+ * the configuration file must be located under the home folder. The server will try different
+ * methods to locate the home folder.
+ *
+ * <ol>
+ *  <li><b>system property</b> - The server will use the value defined in the <i>messengerHome</i>
+ *      system property.</li>
+ *  <li><b>working folder</b> -  The server will check if there is a <i>conf</i> folder in the
+ *      working directory. This is the case when running in standalone mode.</li>
+ *  <li><b>messenger_init.xml file</b> - Attempt to load the value from messenger_init.xml which
+ *      must be in the classpath</li>
+ * </ol>
  *
  * @author Gaston Dombiak
  */

src/java/org/jivesoftware/util/JiveGlobals.java

@@ -18,26 +18,16 @@ import java.util.*;
 
 /**
  * Controls Jive properties. Jive properties are only meant to be set and retrieved
- * by core Jive classes.
- * <p/>
- * The location of the home directory should be specified one of
- * three ways:
- * <ol>
- * <li>Set a Java system property named <tt>home</tt> with the full path to your
- * home directory.
- * <li>Indicate its value in the <tt>messenger_init.xml</tt> file. This
- * is a simple xml file that should look something like:<br>
- * <tt><home>c:\JiveMessenger</home></tt> (Windows) <br>
- * or <br>
- * <tt><home>/var/JiveMessenger</home></tt> (Unix) <p>
- * <p/>
- * The file must be in your classpath so that it can be loaded by Java's classloader.
- * <li>Use another class in your VM to set the <tt>JiveGlobals.home</tt> variable.
- * This must be done before the rest of Jive starts up, for example: in a servlet that
- * is set to run as soon as the appserver starts up.
- * </ol>
- * <p/>
- * All property names must be in the form <code>prop.name</code> - parts of the name must
+ * by core Jive classes. Some properties may be stored in XML format while others in the
+ * database.<p>
+ *
+ * When starting up the application this class needs to be configured so that the initial
+ * configuration of the application may be loaded from the configuration file. The configuration
+ * file holds properties stored in XML format, database configuration and user authentication
+ * configuration. Use {@link #setHomeDirectory(String)} and {@link #setConfigName(String)} for
+ * setting the home directory and path to the configuration file.<p>
+ *
+ * XML property names must be in the form <code>prop.name</code> - parts of the name must
  * be seperated by ".". The value can be any valid String, including strings with line breaks.
  */
 public class JiveGlobals {