Reports fixes

Javadoc added

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

src/com/dmdirc/ui/ChannelFrame.java

@@ -30,10 +30,10 @@ import com.dmdirc.commandparser.CommandManager;
 import com.dmdirc.commandparser.CommandParser;
 import com.dmdirc.commandparser.ServerCommand;
 import com.dmdirc.parser.ChannelClientInfo;
-import static com.dmdirc.ui.UIUtilities.SMALL_BORDER;
 import com.dmdirc.ui.components.InputFrame;
 import com.dmdirc.ui.dialogs.channelsetting.ChannelSettingsDialog;
 import com.dmdirc.ui.input.InputHandler;
+import static com.dmdirc.ui.UIUtilities.SMALL_BORDER;
 
 import java.awt.BorderLayout;
 import java.awt.Color;

src/com/dmdirc/ui/MainFrame.java

@@ -30,7 +30,6 @@ import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
-import static com.dmdirc.ui.UIUtilities.SMALL_BORDER;
 import com.dmdirc.ui.components.Frame;
 import com.dmdirc.ui.components.StatusBar;
 import com.dmdirc.ui.dialogs.AboutDialog;
@@ -44,6 +43,7 @@ import com.dmdirc.ui.framemanager.FramemanagerPosition;
 import com.dmdirc.ui.framemanager.MainFrameManager;
 import com.dmdirc.ui.framemanager.windowmenu.WindowMenuFrameManager;
 import com.dmdirc.ui.interfaces.Window;
+import static com.dmdirc.ui.UIUtilities.SMALL_BORDER;
 
 import java.awt.BorderLayout;
 import java.awt.Color;
@@ -321,7 +321,7 @@ public final class MainFrame extends JFrame implements WindowListener,
     }
     
     /**
-     * Returns the size of the frame manager
+     * Returns the size of the frame manager.
      *
      * @return Frame manager size.
      */
@@ -531,7 +531,11 @@ public final class MainFrame extends JFrame implements WindowListener,
         pack();
     }
     
-    /** Initialises the split pane. */
+    /** 
+     * Initialises the split pane. 
+     *
+     * @param mainSplitPane JSplitPane to initialise
+     */
     private void initSplitPane(final JSplitPane mainSplitPane) {
         mainSplitPane.setBorder(null);
         
@@ -787,6 +791,7 @@ public final class MainFrame extends JFrame implements WindowListener,
         }
     }
     
+    /** Quits the client. */
     public void quit() {
         Config.setOption("ui", "frameManagerSize",
                 String.valueOf(MainFrame.getMainFrame().getFrameManagerSize()));

src/com/dmdirc/ui/QueryFrame.java

@@ -25,9 +25,9 @@ package com.dmdirc.ui;
 import com.dmdirc.Query;
 import com.dmdirc.commandparser.CommandParser;
 import com.dmdirc.commandparser.QueryCommandParser;
-import static com.dmdirc.ui.UIUtilities.SMALL_BORDER;
 import com.dmdirc.ui.components.InputFrame;
 import com.dmdirc.ui.input.InputHandler;
+import static com.dmdirc.ui.UIUtilities.SMALL_BORDER;
 
 import java.awt.GridBagConstraints;
 import java.awt.GridBagLayout;

src/com/dmdirc/ui/ServerFrame.java

@@ -26,10 +26,11 @@ import com.dmdirc.Config;
 import com.dmdirc.Server;
 import com.dmdirc.commandparser.CommandParser;
 import com.dmdirc.commandparser.ServerCommandParser;
-import static com.dmdirc.ui.UIUtilities.SMALL_BORDER;
 import com.dmdirc.ui.components.InputFrame;
 import com.dmdirc.ui.input.InputHandler;
 import com.dmdirc.ui.interfaces.ServerWindow;
+import static com.dmdirc.ui.UIUtilities.SMALL_BORDER;
+
 import java.awt.BorderLayout;
 
 import java.awt.GridBagConstraints;

src/com/dmdirc/ui/components/InputFrame.java

@@ -22,12 +22,12 @@
 
 package com.dmdirc.ui.components;
 
-import static com.dmdirc.ui.UIUtilities.SMALL_BORDER;
 import com.dmdirc.Config;
 import com.dmdirc.WritableFrameContainer;
 import com.dmdirc.identities.ConfigManager;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
+import static com.dmdirc.ui.UIUtilities.SMALL_BORDER;
 import com.dmdirc.ui.dialogs.PasteDialog;
 import com.dmdirc.ui.input.InputHandler;
 import com.dmdirc.ui.interfaces.InputWindow;
@@ -85,9 +85,6 @@ public abstract class InputFrame extends Frame implements InputWindow,
     /** The InputHandler for our input field. */
     private InputHandler inputHandler;
     
-    /** Input field panel. */
-    protected JPanel inputPanel;
-    
     /** Frame input field. */
     private JTextField inputField;
     
@@ -106,6 +103,9 @@ public abstract class InputFrame extends Frame implements InputWindow,
     /** Robot for the frame. */
     private Robot robot;
     
+    /** Input field panel. */
+    protected JPanel inputPanel;
+    
     /** Away label. */
     protected JLabel awayLabel;
     
@@ -197,7 +197,7 @@ public abstract class InputFrame extends Frame implements InputWindow,
         
         // Listen for undo and redo events
         doc.addUndoableEditListener(new UndoableEditListener() {
-            public void undoableEditHappened(UndoableEditEvent evt) {
+            public void undoableEditHappened(final UndoableEditEvent evt) {
                 undo.addEdit(evt.getEdit());
             }
         });
@@ -206,7 +206,7 @@ public abstract class InputFrame extends Frame implements InputWindow,
         getInputField().getActionMap().put("Undo",
                 new AbstractAction("Undo") {
             private static final long serialVersionUID = 1;
-            public void actionPerformed(ActionEvent evt) {
+            public void actionPerformed(final ActionEvent evt) {
                 try {
                     if (undo.canUndo()) {
                         undo.undo();
@@ -224,7 +224,7 @@ public abstract class InputFrame extends Frame implements InputWindow,
         getInputField().getActionMap().put("Redo",
                 new AbstractAction("Redo") {
             private static final long serialVersionUID = 1;
-            public void actionPerformed(ActionEvent evt) {
+            public void actionPerformed(final ActionEvent evt) {
                 try {
                     if (undo.canRedo()) {
                         undo.redo();

src/com/dmdirc/ui/framemanager/FramemanagerPosition.java

@@ -39,6 +39,13 @@ public enum FramemanagerPosition {
     /** Unknown position. */
     UNKNOWN;
     
+    /**
+     * Returns the frame position for s specified string.
+     *
+     * @param name Name of the string
+     *
+     * @return FramemanagerPosition for the string
+     */
     public static FramemanagerPosition getPosition(final String name) {
         if (name == null) {
             return UNKNOWN;

src/com/dmdirc/ui/framemanager/buttonbar/ButtonBar.java

@@ -48,8 +48,8 @@ import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import javax.swing.BorderFactory;
 
+import javax.swing.BorderFactory;
 import javax.swing.JComponent;
 import javax.swing.JPanel;
 import javax.swing.JToggleButton;
@@ -296,7 +296,7 @@ public final class ButtonBar implements FrameManager, ActionListener,
      *
      * @param e A ComponentEvent corresponding to this event.
      */
-    public void componentResized(ComponentEvent e) {
+    public void componentResized(final ComponentEvent e) {
         buttonWidth = position.isHorizontal() ? 150 : (parent.getWidth() - UIUtilities.SMALL_BORDER * 3) / cells;
         
         if (position.isHorizontal()) {
@@ -311,7 +311,7 @@ public final class ButtonBar implements FrameManager, ActionListener,
      *
      * @param e A ComponentEvent corresponding to this event.
      */
-    public void componentMoved(ComponentEvent e) {
+    public void componentMoved(final ComponentEvent e) {
         // Do nothing
     }
     
@@ -320,7 +320,7 @@ public final class ButtonBar implements FrameManager, ActionListener,
      *
      * @param e A ComponentEvent corresponding to this event.
      */
-    public void componentShown(ComponentEvent e) {
+    public void componentShown(final ComponentEvent e) {
         // Do nothing
     }
     
@@ -329,7 +329,7 @@ public final class ButtonBar implements FrameManager, ActionListener,
      *
      * @param e A ComponentEvent corresponding to this event.
      */
-    public void componentHidden(ComponentEvent e) {
+    public void componentHidden(final ComponentEvent e) {
         // Do nothing
     }
     

src/com/dmdirc/ui/framemanager/buttonbar/ButtonComparator.java

@@ -27,6 +27,7 @@ import com.dmdirc.FrameContainer;
 import com.dmdirc.Query;
 import com.dmdirc.Raw;
 import com.dmdirc.Server;
+
 import java.util.Comparator;
 
 /**
@@ -35,7 +36,7 @@ import java.util.Comparator;
  *
  * @author chris
  */
-public class ButtonComparator implements Comparator<FrameContainer> {
+public final class ButtonComparator implements Comparator<FrameContainer> {
     
     /**
      * Returns an integer corresponding to the expected order of an object.
@@ -58,8 +59,8 @@ public class ButtonComparator implements Comparator<FrameContainer> {
     }
     
     /** {@inheritDoc} */
-    public int compare(FrameContainer o1, FrameContainer o2) {
+    public int compare(final FrameContainer o1, final FrameContainer o2) {
         return getPosition(o1) - getPosition(o2);
     }
     
-}
+}

src/com/dmdirc/ui/framemanager/buttonbar/package-info.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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
+ * 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
+ * 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
+ * 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.
+ */
+
+/**
+ * Button bar frame manager
+ */
+package com.dmdirc.ui.framemanager.buttonbar;

src/com/dmdirc/ui/framemanager/windowmenu/package-info.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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
+ * 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
+ * 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
+ * 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.
+ */
+
+/**
+ * Window menu list frame manager.
+ */
+package com.dmdirc.ui.framemanager.windowmenu;

src/com/dmdirc/ui/input/AdditionalTabTargets.java

@@ -31,7 +31,7 @@ import java.util.ArrayList;
  * 
  * @author chris
  */
-public class AdditionalTabTargets extends ArrayList<String> {
+public final class AdditionalTabTargets extends ArrayList<String> {
     
     /**
      * A version number for this class. It should be changed whenever the class
@@ -63,4 +63,4 @@ public class AdditionalTabTargets extends ArrayList<String> {
         this.includeNormal = includeNormal;
     }    
 
-}
+}

src/com/dmdirc/ui/input/InputHandler.java

@@ -27,8 +27,8 @@ import com.dmdirc.commandparser.Command;
 import com.dmdirc.commandparser.CommandManager;
 import com.dmdirc.commandparser.CommandParser;
 import com.dmdirc.commandparser.IntelligentCommand;
-import com.dmdirc.ui.interfaces.InputWindow;
 import com.dmdirc.ui.components.ColourPickerDialog;
+import com.dmdirc.ui.interfaces.InputWindow;
 import com.dmdirc.ui.messages.Styliser;
 
 import java.awt.event.ActionEvent;
@@ -262,7 +262,7 @@ public final class InputHandler implements KeyListener, ActionListener {
      * Handles tab completion of a string. Called when the user presses tab.
      */
     private void doTabCompletion() {
-        String text = target.getText();
+        final String text = target.getText();
         
         if (text.length() == 0) {
             doNormalTabCompletion(text, 0, 0, null);

src/com/dmdirc/ui/interfaces/ServerWindow.java

@@ -29,4 +29,4 @@ package com.dmdirc.ui.interfaces;
  */
 public interface ServerWindow extends InputWindow {
     
-}
+}

src/com/dmdirc/ui/messages/Formatter.java

@@ -36,7 +36,6 @@ import java.util.InvalidPropertiesFormatException;
 import java.util.Properties;
 import java.util.Set;
 import java.util.UnknownFormatConversionException;
-import java.util.logging.Level;
 
 /**
  * The Formatter provides a standard way to format messages for display.