Tidied up formatting of all (non-parser) code and javadoc'd everything except for autogenerated UI variables

git-svn-id: http://svn.dmdirc.com/trunk@34 00569f92-eb28-0410-84fd-f71c24880f

src/dmdirc/Channel.java

@@ -4,17 +4,17 @@
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
  *
- * The above copyright notice and this permission notice shall be included in 
+ * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
  *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.

src/dmdirc/Config.java

@@ -31,6 +31,9 @@ import java.util.Properties;
  */
 public class Config {
     
+    /**
+     * The application's current configuration
+     */
     private static Properties properties;
     
     /** Creates a new instance of Config */
@@ -54,6 +57,10 @@ public class Config {
         return System.getProperty("user.home")+fs+".DMDirc"+fs;
     }
     
+    /**
+     * Returns the default settings for DMDirc
+     * @return default settings
+     */
     private static Properties getDefaults() {
         Properties defaults = new Properties();
         
@@ -63,12 +70,24 @@ public class Config {
         return defaults;
     }
     
+    /**
+     * Determines if the specified option exists
+     * @return true iff the option exists, false otherwise
+     * @param domain the domain of the option
+     * @param option the name of the option
+     */
     public static boolean hasOption(String domain, String option) {
         assert(properties != null);
         
         return (properties.getProperty(domain+"."+option) != null);
     }
     
+    /**
+     * Returns the specified option
+     * @return the value of the specified option
+     * @param domain the domain of the option
+     * @param option the name of the option
+     */
     public static String getOption(String domain, String option) {
         assert(properties != null);
         

src/dmdirc/Main.java

@@ -4,17 +4,17 @@
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
  *
- * The above copyright notice and this permission notice shall be included in 
+ * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
  *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.

src/dmdirc/Raw.java

@@ -27,15 +27,25 @@ import dmdirc.ui.MainFrame;
 import dmdirc.ui.ServerFrame;
 
 /**
- *
+ * Handles the raw window (which shows the user raw data being sent and
+ * received to/from the server)
  * @author chris
  */
 public class Raw {
     
+    /**
+     * The server object that's being monitored
+     */
     private Server server;
+    /**
+     * A serverframe instance used for displaying the raw data
+     */
     private ServerFrame frame;
     
-    /** Creates a new instance of Raw */
+    /**
+     * Creates a new instance of Raw
+     * @param server the server to monitor
+     */
     public Raw(Server server) {
         this.server = server;
         

src/dmdirc/Server.java

@@ -4,17 +4,17 @@
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
  *
- * The above copyright notice and this permission notice shall be included in 
+ * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
  *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
@@ -51,7 +51,11 @@ public class Server {
      */
     private IRCParser parser;
     
-    /** Creates a new instance of Server */
+    /**
+     * Creates a new instance of Server
+     * @param server The hostname/ip of the server to connect to
+     * @param port The port to connect to
+     */
     public Server(String server, int port) {
         
         channels = new Vector(0,1);
@@ -86,15 +90,33 @@ public class Server {
     
     /**
      * Called on destruction, the server unregisters itself with the ServerManager
+     * @throws java.lang.Throwable ...
      */
     protected void finalize() throws Throwable {
         ServerManager.getServerManager().unregisterServer(this);
     }
     
-    public void AddDataIn (Object eMethod) { parser.AddDataIn(eMethod); }
-    public void AddDataOut (Object eMethod) { parser.AddDataOut(eMethod); }
-    public void AddMOTDEnd (Object eMethod) { parser.AddMOTDEnd(eMethod); }
+    /**
+     * Adds a listener for the DataIn event for this server's connection
+     * @param eMethod the listener to notify
+     */
+    public void AddDataIn(Object eMethod) { parser.AddDataIn(eMethod); }
+    /**
+     * Adds a listener for the DataOut event for this server's connection
+     * @param eMethod the listener to notify
+     */
+    public void AddDataOut(Object eMethod) { parser.AddDataOut(eMethod); }
+    /**
+     * Adds a listener for the EndOfMOTD event for this server's connection
+     * @param eMethod The listener to notify
+     */
+    public void AddMOTDEnd(Object eMethod) { parser.AddMOTDEnd(eMethod); }
     
-    public void SendRawLine (String line) { parser.SendLine(line); }
+    /**
+     * Sends a raw line directly to the server
+     * @param line The line of text to send to the server
+     * @see IRCParser.SendLine(java.lang.String)
+     */
+    public void SendRawLine(String line) { parser.SendLine(line); }
     
 }

src/dmdirc/ServerManager.java

@@ -4,17 +4,17 @@
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
  *
- * The above copyright notice and this permission notice shall be included in 
+ * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
  *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
@@ -25,7 +25,7 @@ package dmdirc;
 import java.util.Vector;
 
 /**
- * The ServerManager maintains a list of all servers, and provides methods to 
+ * The ServerManager maintains a list of all servers, and provides methods to
  * search or iterate over them.
  * @author chris
  */
@@ -61,7 +61,7 @@ public class ServerManager {
      * Registers a new server with the manager
      * @param server The server to be registered
      */
-    public void registerServer (Server server) {
+    public void registerServer(Server server) {
         servers.add(server);
     }
     
@@ -69,12 +69,16 @@ public class ServerManager {
      * Unregisters a server from the manager
      * @param server The server to be unregistered
      */
-    public void unregisterServer (Server server) {
+    public void unregisterServer(Server server) {
         servers.remove(server);
     }
     
-    public int numServers () {
+    /**
+     * Returns the number of servers that are registered with the manager
+     * @return number of registered servers
+     */
+    public int numServers() {
         return servers.size();
     }
-       
+    
 }

src/dmdirc/ui/MainFrame.java

@@ -4,17 +4,17 @@
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
  *
- * The above copyright notice and this permission notice shall be included in 
+ * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
  *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
@@ -61,9 +61,13 @@ public class MainFrame extends javax.swing.JFrame {
         });
     }
     
+    /**
+     * Adds the specified InternalFrame as a child of the main frame
+     * @param frame the frame to be added
+     */
     public void addChild(JInternalFrame frame) {
         desktopPane.add(frame);
-    }    
+    }
     
     /** This method is called from within the constructor to
      * initialize the form.

src/dmdirc/ui/NewServerDialog.java

@@ -33,13 +33,19 @@ import javax.swing.JComponent;
 import javax.swing.JTextField;
 
 /**
- *
- * @author  chris
+ * Dialog that allows the user to enter details of a new server to connect to
+ * @author chris
  */
 public class NewServerDialog extends javax.swing.JDialog {
     
+    /**
+     * A previously created instance of NewServerDialog
+     */
     private static NewServerDialog me;
     
+    /**
+     * Creates a new instance of the dialog
+     */
     private NewServerDialog() {
         super((java.awt.Frame)MainFrame.getMainFrame(), false);
         
@@ -57,6 +63,9 @@ public class NewServerDialog extends javax.swing.JDialog {
         setVisible(true);
     }
     
+    /**
+     * Creates the new server dialog if one doesn't exist, and displays it.
+     */
     public static void showNewServerDialog() {
         if (me == null) {
             me = new NewServerDialog();
@@ -66,6 +75,9 @@ public class NewServerDialog extends javax.swing.JDialog {
         }
     }
     
+    /**
+     * Adds listeners for various objects in the dialog
+     */
     private void addCallbacks() {
         jButton2.addActionListener(new ActionListener() {
             public void actionPerformed(ActionEvent actionEvent) {
@@ -224,8 +236,16 @@ public class NewServerDialog extends javax.swing.JDialog {
     
 }
 
+/**
+ * Verifies that the port number is a valid port
+ */
 class PortVerifier extends InputVerifier {
     
+    /**
+     * Verifies that the number specified in the textfield is a valid port
+     * @param jComponent The component to be tested
+     * @return true iff the number is a valid port, false otherwise
+     */
     public boolean verify(JComponent jComponent) {
         JTextField tf = (JTextField)jComponent;
         try {

src/dmdirc/ui/ServerFrame.java

@@ -4,17 +4,17 @@
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
  *
- * The above copyright notice and this permission notice shall be included in 
+ * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
  *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
@@ -37,10 +37,19 @@ import javax.swing.plaf.metal.MetalInternalFrameUI;
  */
 public class ServerFrame extends javax.swing.JInternalFrame {
     
+    /**
+     * The Server object that owns this frame
+     */
     private Server parent;
+    /**
+     * The border used when the frame is not maximised
+     */
     private Border myborder;
     
-    /** Creates new form ServerFrame */
+    /**
+     * Creates new form ServerFrame
+     * @param parent The server instance that owns this frame
+     */
     public ServerFrame(Server parent) {
         initComponents();
         setMaximizable(true);
@@ -70,6 +79,10 @@ public class ServerFrame extends javax.swing.JInternalFrame {
         
     }
     
+    /**
+     * Adds a line of text to the main text area
+     * @param line text to add
+     */
     public void addLine(String line) {
         jTextArea1.append(line+"\n");
     }