Tidy javadoc

Change-Id: If8c377f64b3b336203ab4d01aaaa0a731f0545a1
Reviewed-on: http://gerrit.dmdirc.com/2885
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/parser/common/BaseParser.java

@@ -38,7 +38,8 @@ import java.util.Map;
  * Implements common base functionality for parsers.<p>
  * Implementations of this class must be annotated with
  * {@link ChildImplementations} to define the implementations to use for
- * instances of {@link ClientInfo}, {@link ChannelInfo}, etc.
+ * instances of {@link com.dmdirc.parser.interfaces.ClientInfo},
+ * {@link com.dmdirc.parser.interfaces.ChannelInfo}, etc.
  */
 public abstract class BaseParser extends ThreadedParser {
 

src/com/dmdirc/parser/common/ChannelListModeItem.java

@@ -27,9 +27,9 @@ package com.dmdirc.parser.common;
  *
  * @author Shane Mc Cormack
  * @author Chris Smith
- * @see IRCParser
+ * @see com.dmdirc.parser.interfaces.Parser
  */
-public final class ChannelListModeItem {
+public class ChannelListModeItem {
 
     /** The Item itself. */
     private final String myItem;

src/com/dmdirc/parser/common/MyInfo.java

@@ -27,7 +27,7 @@ package com.dmdirc.parser.common;
  *
  * @author Shane Mc Cormack
  * @author Chris Smith
- * @see IRCParser
+ * @see com.dmdirc.parser.interfaces.Parser
  */
 public class MyInfo {
 

src/com/dmdirc/parser/common/SRVRecord.java

@@ -22,8 +22,9 @@
 package com.dmdirc.parser.common;
 
 import java.util.ArrayList;
-import java.util.Hashtable; // NOPMD - Required by InitialDirContext
+import java.util.Hashtable;
 import java.util.List;
+
 import javax.naming.NamingEnumeration;
 import javax.naming.NamingException;
 import javax.naming.directory.Attribute;
@@ -49,7 +50,7 @@ public class SRVRecord implements Comparable<SRVRecord> {
      * Create a new SRV Record from a String.
      *
      * @param record Record as a string.
-     * @throws NamingException
+     * @throws NamingException if the record is invalid
      */
     public SRVRecord(final String record) throws NamingException {
         final String[] bits = record.split(" ", 4);
@@ -117,11 +118,11 @@ public class SRVRecord implements Comparable<SRVRecord> {
     }
 
     public static List<SRVRecord> getRecords(final String host) {
-        final List<SRVRecord> result = new ArrayList<SRVRecord>();
+        final List<SRVRecord> result = new ArrayList<>();
 
         try {
             // Obsolete Collection. yeah yeah...
-            final Hashtable<String, String> env = new Hashtable<String, String>(); // NOPMD - Required by InitialDirContext
+            final Hashtable<String, String> env = new Hashtable<>(); // NOPMD - Required by InitialDirContext
             env.put("java.naming.factory.initial", "com.sun.jndi.dns.DnsContextFactory");
             env.put("java.naming.provider.url", "dns:");
             final Attribute attr = new InitialDirContext(env).getAttributes(host, new String [] { "SRV" }).get("SRV");

src/com/dmdirc/parser/interfaces/Parser.java

@@ -44,8 +44,6 @@ public interface Parser {
 
     /**
      * Connect to server.
-     *
-     * @param threadName Name for any parser thread.
      */
     void connect();
 

src/com/dmdirc/parser/interfaces/callbacks/ChannelOtherAwayStateListener.java

@@ -45,7 +45,6 @@ public interface ChannelOtherAwayStateListener extends CallbackInterface {
      * @param client Client this is for
      * @param oldState Old Away State
      * @param state Current Away State
-     * @see com.dmdirc.parser.irc.ProcessAway#callChannelAwayStateOther
      */
     void onChannelAwayStateOther(Parser parser, Date date, ChannelInfo channel,
             ChannelClientInfo client, AwayState oldState, AwayState state);

src/com/dmdirc/parser/interfaces/callbacks/OtherAwayStateListener.java

@@ -39,11 +39,10 @@ public interface OtherAwayStateListener extends CallbackInterface {
      * Called when we go away, or come back.
      *
      * @param parser Reference to the parser object that made the callback.
-     * @param date The date/time at which the event occured
+     * @param date The date/time at which the event occurred
      * @param client Client this is for
      * @param oldState Old Away State
      * @param state Current Away State
-     * @see com.dmdirc.parser.irc.ProcessAway#callAwayStateOther
      */
     void onAwayStateOther(Parser parser, Date date, ClientInfo client,
             AwayState oldState, AwayState state);

src/com/dmdirc/parser/interfaces/callbacks/PasswordRequiredListener.java

@@ -36,7 +36,6 @@ public interface PasswordRequiredListener extends CallbackInterface {
      *
      * @param parser Reference to the parser object that made the callback.
      * @param date The date/time at which the event occured
-     * @see com.dmdirc.parser.irc.Process004005#callPasswordRequired
      */
     void onPasswordRequired(Parser parser, Date date);
 

src/com/dmdirc/parser/interfaces/callbacks/PingFailureListener.java

@@ -35,8 +35,7 @@ public interface PingFailureListener extends CallbackInterface {
      * Called when a ping failed.
      *
      * @param parser Reference to the parser object that made the callback.
-     * @param date The date/time at which the event occured
-     * @see IRCParser#callPingFailed
+     * @param date The date/time at which the event occurred
      */
     void onPingFailed(Parser parser, Date date);
 

src/com/dmdirc/parser/interfaces/callbacks/PingSentListener.java

@@ -35,8 +35,7 @@ public interface PingSentListener extends CallbackInterface {
      * Called when a ping was Sent.
      *
      * @param parser Reference to the parser object that made the callback.
-     * @param date The date/time at which the event occured
-     * @see IRCParser#callPingSent
+     * @param date The date/time at which the event occurred
      */
     void onPingSent(Parser parser, Date date);
 

src/com/dmdirc/parser/interfaces/callbacks/PingSuccessListener.java

@@ -35,8 +35,7 @@ public interface PingSuccessListener extends CallbackInterface {
      * Called when a ping was a Success.
      *
      * @param parser Reference to the parser object that made the callback.
-     * @param date The date/time at which the event occured
-     * @see IRCParser#callPingSuccess
+     * @param date The date/time at which the event occurred
      */
     void onPingSuccess(Parser parser, Date date);
 

src/com/dmdirc/parser/interfaces/callbacks/ServerReadyListener.java

@@ -35,8 +35,7 @@ public interface ServerReadyListener extends CallbackInterface {
      * Called after 001.
      *
      * @param parser Reference to the parser object that made the callback.
-     * @param date The date/time at which the event occured
-     * @see com.dmdirc.parser.irc.Process001#callServerReady
+     * @param date The date/time at which the event occurred
      */
     void onServerReady(Parser parser, Date date);
 

src/com/dmdirc/parser/irc/CapabilityState.java

@@ -24,8 +24,6 @@ package com.dmdirc.parser.irc;
 /**
  * Capability states.
  * See: http://ircv3.atheme.org/specification/capability-negotiation-3.1
- *
- * @author Shane Mc Cormack <shanemcc@gmail.com>
  */
 public enum CapabilityState {
     /** Capability is invalid*/
@@ -41,7 +39,7 @@ public enum CapabilityState {
     ENABLED("Enabled", '+');
 
     /** Description. */
-    private String description;
+    private final String description;
 
     /**
      * Modifier.
@@ -49,7 +47,7 @@ public enum CapabilityState {
      * as "capability modifiers". We just use them to make parsing the messages
      * a bit easier.
      */
-    private Character modifier;
+    private final Character modifier;
 
     /**
      * Create a CapabilityState.
@@ -82,6 +80,8 @@ public enum CapabilityState {
     /**
      * Get the capability state for the given modifier, or null.
      *
+     * @param modifier Modifier to get the capability for
+     *
      * @return state for the given modifier, or null.
      */
     public static CapabilityState fromModifier(final char modifier) {

src/com/dmdirc/parser/irc/IRCClientInfo.java

@@ -71,7 +71,7 @@ public class IRCClientInfo implements LocalClientInfo {
      *
      * @param tParser Refernce to parser that owns this channelclient (used for modes)
      * @param sHostmask Hostmask parsed by parseHost to get nickname
-     * @see ClientInfo#parseHost
+     * @see IRCClientInfo#parseHost
      */
     public IRCClientInfo(final IRCParser tParser, final String sHostmask) {
         map = new HashMap<Object, Object>();
@@ -132,7 +132,8 @@ public class IRCClientInfo implements LocalClientInfo {
      * Hostmask must match (?:)nick(?!ident)(?@host)
      *
      * @param hostmask Hostname to parse
-     * @return Array containing details. (result[0] -> Nick | result[1] -> Ident | result[2] -> Host)
+     * @return Array containing details. (result[0] -&gt; Nick | result[1]
+     * -&gt; Ident | result[2] - Host)
      */
     public static String[] parseHostFull(final String hostmask) {
         String[] sTemp;

src/com/dmdirc/parser/irc/IRCParser.java

@@ -34,7 +34,17 @@ import com.dmdirc.parser.common.SystemEncoder;
 import com.dmdirc.parser.interfaces.Encoder;
 import com.dmdirc.parser.interfaces.EncodingParser;
 import com.dmdirc.parser.interfaces.SecureParser;
-import com.dmdirc.parser.interfaces.callbacks.*; //NOPMD
+import com.dmdirc.parser.interfaces.callbacks.ConnectErrorListener;
+import com.dmdirc.parser.interfaces.callbacks.DataInListener;
+import com.dmdirc.parser.interfaces.callbacks.DataOutListener;
+import com.dmdirc.parser.interfaces.callbacks.DebugInfoListener;
+import com.dmdirc.parser.interfaces.callbacks.ErrorInfoListener;
+import com.dmdirc.parser.interfaces.callbacks.PingFailureListener;
+import com.dmdirc.parser.interfaces.callbacks.PingSentListener;
+import com.dmdirc.parser.interfaces.callbacks.PingSuccessListener;
+import com.dmdirc.parser.interfaces.callbacks.ServerErrorListener;
+import com.dmdirc.parser.interfaces.callbacks.ServerReadyListener;
+import com.dmdirc.parser.interfaces.callbacks.SocketCloseListener;
 import com.dmdirc.parser.irc.IRCReader.ReadLine;
 import com.dmdirc.parser.irc.outputqueue.OutputQueue;
 
@@ -559,7 +569,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
     /**
      * Callback to all objects implementing the ServerError Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IServerError
+     * @see com.dmdirc.parser.interfaces.callbacks.ServerErrorListener
      * @param message The error message
      */
     protected void callServerError(final String message) {
@@ -569,7 +579,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
     /**
      * Callback to all objects implementing the DataIn Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IDataIn
+     * @see com.dmdirc.parser.interfaces.callbacks.DataInListener
      * @param data Incoming Line.
      */
     protected void callDataIn(final String data) {
@@ -581,7 +591,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
      *
      * @param data Outgoing Data
      * @param fromParser True if parser sent the data, false if sent using .sendLine
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IDataOut
+     * @see com.dmdirc.parser.interfaces.callbacks.DataOutListener
      */
     protected void callDataOut(final String data, final boolean fromParser) {
         getCallback(DataOutListener.class).onDataOut(null, null, data, fromParser);
@@ -590,7 +600,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
     /**
      * Callback to all objects implementing the DebugInfo Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IDebugInfo
+     * @see com.dmdirc.parser.interfaces.callbacks.DebugInfoListener
      * @param level Debugging Level (DEBUG_INFO, DEBUG_SOCKET etc)
      * @param data Debugging Information as a format string
      * @param args Formatting String Options
@@ -602,7 +612,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
     /**
      * Callback to all objects implementing the DebugInfo Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IDebugInfo
+     * @see com.dmdirc.parser.interfaces.callbacks.DebugInfoListener
      * @param level Debugging Level (DEBUG_INFO, DEBUG_SOCKET etc)
      * @param data Debugging Information
      */
@@ -613,7 +623,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
     /**
      * Callback to all objects implementing the IErrorInfo Interface.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IErrorInfo
+     * @see com.dmdirc.parser.interfaces.callbacks.ErrorInfoListener
      * @param errorInfo ParserError object representing the error.
      */
     protected void callErrorInfo(final ParserError errorInfo) {
@@ -623,7 +633,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
     /**
      * Callback to all objects implementing the IConnectError Interface.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IConnectError
+     * @see com.dmdirc.parser.interfaces.callbacks.ConnectErrorListener
      * @param errorInfo ParserError object representing the error.
      */
     protected void callConnectError(final ParserError errorInfo) {
@@ -633,7 +643,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
     /**
      * Callback to all objects implementing the SocketClosed Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.ISocketClosed
+     * @see com.dmdirc.parser.interfaces.callbacks.SocketCloseListener
      */
     protected void callSocketClosed() {
         getCallback(SocketCloseListener.class).onSocketClosed(null, null);
@@ -642,7 +652,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
     /**
      * Callback to all objects implementing the PingFailed Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IPingFailed
+     * @see com.dmdirc.parser.interfaces.callbacks.PingFailureListener
      * @return True if any callback was called, false otherwise.
      */
     protected boolean callPingFailed() {
@@ -652,7 +662,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
     /**
      * Callback to all objects implementing the PingSent Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IPingSent
+     * @see com.dmdirc.parser.interfaces.callbacks.PingSentListener
      */
     protected void callPingSent() {
         getCallback(PingSentListener.class).onPingSent(null, null);
@@ -661,7 +671,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
     /**
      * Callback to all objects implementing the PingSuccess Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IPingSuccess
+     * @see com.dmdirc.parser.interfaces.callbacks.PingSuccessListener
      */
     protected void callPingSuccess() {
         getCallback(PingSuccessListener.class).onPingSuccess(null, null);
@@ -670,7 +680,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
     /**
      * Callback to all objects implementing the Post005 Callback.
      *
-     * @see IPost005
+     * @see com.dmdirc.parser.interfaces.callbacks.ServerReadyListener
      */
     protected synchronized void callPost005() {
         if (post005) {

src/com/dmdirc/parser/irc/IRCProcessor.java

@@ -53,7 +53,7 @@ public abstract class IRCProcessor {
     /**
      * Callback to all objects implementing the IErrorInfo Interface.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IErrorInfo
+     * @see com.dmdirc.parser.interfaces.callbacks.ErrorInfoListener
      * @param errorInfo ParserError object representing the error.
      */
     protected final void callErrorInfo(final ParserError errorInfo) {
@@ -63,7 +63,7 @@ public abstract class IRCProcessor {
     /**
      * Callback to all objects implementing the DebugInfo Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IDebugInfo
+     * @see com.dmdirc.parser.interfaces.callbacks.DebugInfoListener
      * @param level Debugging Level (DEBUG_INFO, ndSocket etc)
      * @param data Debugging Information
      * @param args Formatting String Options
@@ -75,7 +75,7 @@ public abstract class IRCProcessor {
     /**
      * Callback to all objects implementing the DebugInfo Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IDebugInfo
+     * @see com.dmdirc.parser.interfaces.callbacks.DebugInfoListener
      * @param level Debugging Level (DEBUG_INFO, ndSocket etc)
      * @param data Debugging Information
      */

src/com/dmdirc/parser/irc/Logging.java

@@ -93,10 +93,7 @@ public class Logging {
                 final Method getLog = factory.getMethod("getLog", new Class[]{Class.class});
                 log = getLog.invoke(null, this.getClass());
             }
-        } catch (ClassNotFoundException cnfe) {
-        } catch (NoSuchMethodException nsme) {
-        } catch (IllegalAccessException iae) {
-        } catch (InvocationTargetException ite) {
+        } catch (ClassNotFoundException | NoSuchMethodException | IllegalAccessException | InvocationTargetException cnfe) {
         }
 
         isAvailable = log != null;
@@ -120,15 +117,15 @@ public class Logging {
      * Check is a log level is available.
      *
      * @param level Level to check
+     *
+     * @return true if the method was invoked
      */
     public boolean levelEnabled(final LogLevel level) {
         if (isAvailable) {
             try {
                 final Method check = log.getClass().getMethod(level.getCheckMethodName());
                 return (Boolean) check.invoke(log, new Object[0]);
-            } catch (NoSuchMethodException nsme) {
-            } catch (IllegalAccessException iae) {
-            } catch (InvocationTargetException ite) {
+            } catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException nsme) {
             }
         }
 
@@ -164,9 +161,7 @@ public class Logging {
                 final Method method = log.getClass().getMethod(level.getMethodName(), String.class, Throwable.class);
                 method.invoke(log, new Object[]{message, throwable});
             }
-        } catch (NoSuchMethodException nsme) {
-        } catch (IllegalAccessException iae) {
-        } catch (InvocationTargetException ite) {
+        } catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException nsme) {
         }
     }
 }

src/com/dmdirc/parser/irc/Process464.java

@@ -63,7 +63,7 @@ public class Process464 extends IRCProcessor {
     /**
      * Callback to all objects implementing the PasswordRequired Callback.
      *
-     * @see IPasswordRequired
+     * @see com.dmdirc.parser.interfaces.callbacks.PasswordRequiredListener
      * @return true if a method was called, false otherwise
      */
     protected boolean callPasswordRequired() {

src/com/dmdirc/parser/irc/ProcessAway.java

@@ -76,7 +76,7 @@ public class ProcessAway extends IRCProcessor {
     /**
      * Callback to all objects implementing the onAwayState Callback.
      *
-     * @see IAwayState
+     * @see com.dmdirc.parser.interfaces.callbacks.AwayStateListener
      * @param oldState Old Away State
      * @param currentState Current Away State
      * @param reason Best guess at away reason

src/com/dmdirc/parser/irc/ProcessInvite.java

@@ -56,7 +56,7 @@ public class ProcessInvite extends IRCProcessor {
     /**
      * Callback to all objects implementing the Invite Callback.
      *
-     * @see IInvite
+     * @see com.dmdirc.parser.interfaces.callbacks.InviteListener
      * @param userHost The hostname of the person who invited us
      * @param channel The name of the channel we were invited to
      * @return true if a method was called, false otherwise

src/com/dmdirc/parser/irc/ProcessJoin.java

@@ -153,7 +153,7 @@ public class ProcessJoin extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelJoin Callback.
      *
-     * @see IChannelJoin
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelJoinListener
      * @param cChannel Channel Object
      * @param cChannelClient ChannelClient object for new person
      * @return true if a method was called, false otherwise
@@ -165,7 +165,7 @@ public class ProcessJoin extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelSelfJoin Callback.
      *
-     * @see IChannelSelfJoin
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelSelfJoinListener
      * @param cChannel Channel Object
      * @return true if a method was called, false otherwise
      */

src/com/dmdirc/parser/irc/ProcessKick.java

@@ -110,7 +110,7 @@ public class ProcessKick extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelKick Callback.
      *
-     * @see IChannelKick
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelKickListener
      * @param cChannel Channel where the kick took place
      * @param cKickedClient ChannelClient that got kicked
      * @param cKickedByClient ChannelClient that did the kicking (may be null if server)

src/com/dmdirc/parser/irc/ProcessListModes.java

@@ -281,7 +281,7 @@ public class ProcessListModes extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelGotListModes Callback.
      *
-     * @see IChannelGotListModes
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelListModeListener
      * @param cChannel Channel which the ListModes reply is for
      * @param mode the mode that we got list modes for.
      * @return true if a method was called, false otherwise

src/com/dmdirc/parser/irc/ProcessMOTD.java

@@ -63,7 +63,7 @@ public class ProcessMOTD extends IRCProcessor {
      *
      * @param noMOTD Was this an MOTDEnd or NoMOTD
      * @param data The contents of the line (incase of language changes or so)
-     * @see IMOTDEnd
+     * @see com.dmdirc.parser.interfaces.callbacks.MotdEndListener
      * @return true if a method was called, false otherwise
      */
     protected boolean callMOTDEnd(final boolean noMOTD, final String data) {
@@ -73,7 +73,7 @@ public class ProcessMOTD extends IRCProcessor {
     /**
      * Callback to all objects implementing the MOTDLine Callback.
      *
-     * @see IMOTDLine
+     * @see com.dmdirc.parser.interfaces.callbacks.MotdLineListener
      * @param data Incomming Line.
      * @return true if a method was called, false otherwise
      */
@@ -84,7 +84,7 @@ public class ProcessMOTD extends IRCProcessor {
     /**
      * Callback to all objects implementing the MOTDStart Callback.
      *
-     * @see IMOTDStart
+     * @see com.dmdirc.parser.interfaces.callbacks.MotdStartListener
      * @param data Incomming Line.
      * @return true if a method was called, false otherwise
      */

src/com/dmdirc/parser/irc/ProcessMessage.java

@@ -277,7 +277,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the ChannelAction Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IChannelAction
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelActionListener
      * @param date The date of this line
      * @param cChannel Channel where the action was sent to
      * @param cChannelClient ChannelClient who sent the action (may be null if server)
@@ -292,7 +292,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the ChannelCTCP Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IChannelCTCP
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelCtcpListener
      * @param date The date of this line
      * @param cChannel Channel where CTCP was sent
      * @param cChannelClient ChannelClient who sent the message (may be null if server)
@@ -308,7 +308,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the ChannelCTCPReply Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IChannelCTCPReply
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelCtcpReplyListener
      * @param date The date of this line
      * @param cChannel Channel where CTCPReply was sent
      * @param cChannelClient ChannelClient who sent the message (may be null if server)
@@ -324,7 +324,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the ChannelMessage Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IChannelMessage
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelMessageListener
      * @param date The date of this line
      * @param cChannel Channel where the message was sent to
      * @param cChannelClient ChannelClient who sent the message (may be null if server)
@@ -339,7 +339,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the ChannelNotice Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IChannelNotice
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelNoticeListener
      * @param date The date of this line
      * @param cChannel Channel where the notice was sent to
      * @param cChannelClient ChannelClient who sent the notice (may be null if server)
@@ -354,7 +354,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the ChannelModeNotice Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IChannelModeNotice
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelModeNoticeListener
      * @param date The date of this line
      * @param prefix Prefix that was used to send this notice.
      * @param cChannel Channel where the notice was sent to
@@ -370,7 +370,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the ChannelModeMessage Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IChannelModeMessage
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelModeMessageListener
      * @param date The date of this line
      * @param prefix Prefix that was used to send this notice.
      * @param cChannel Channel where the notice was sent to
@@ -386,7 +386,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the PrivateAction Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IPrivateAction
+     * @see com.dmdirc.parser.interfaces.callbacks.PrivateActionListener
      * @param date The date of this line
      * @param sMessage action contents
      * @param sHost Hostname of sender (or servername)
@@ -399,7 +399,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the PrivateCTCP Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IPrivateCTCP
+     * @see com.dmdirc.parser.interfaces.callbacks.PrivateCtcpListener
      * @param date The date of this line
      * @param sType Type of CTCP (VERSION, TIME etc)
      * @param sMessage Additional contents
@@ -413,7 +413,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the PrivateCTCPReply Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IPrivateCTCPReply
+     * @see com.dmdirc.parser.interfaces.callbacks.PrivateCtcpReplyListener
      * @param date The date of this line
      * @param sType Type of CTCPRReply (VERSION, TIME etc)
      * @param sMessage Reply Contents
@@ -427,7 +427,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the PrivateMessage Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IPrivateMessage
+     * @see com.dmdirc.parser.interfaces.callbacks.PrivateMessageListener
      * @param date The date of this line
      * @param sMessage Message contents
      * @param sHost Hostname of sender (or servername)
@@ -440,7 +440,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the PrivateNotice Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IPrivateNotice
+     * @see com.dmdirc.parser.interfaces.callbacks.PrivateNoticeListener
      * @param date The date of this line
      * @param sMessage Notice contents
      * @param sHost Hostname of sender (or servername)
@@ -453,7 +453,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the ServerNotice Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.ServerNotice
+     * @see com.dmdirc.parser.interfaces.callbacks.ServerNoticeListener
      * @param date The date of this line
      * @param sMessage Notice contents
      * @param sHost Hostname of sender (or servername)
@@ -466,7 +466,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the UnknownAction Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IUnknownAction
+     * @see com.dmdirc.parser.interfaces.callbacks.UnknownActionListener
      * @param date The date of this line
      * @param sMessage Action contents
      * @param sTarget Actual target of action
@@ -480,7 +480,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the UnknownCTCP Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IUnknownCTCP
+     * @see com.dmdirc.parser.interfaces.callbacks.UnknownCtcpListener
      * @param date The date of this line
      * @param sType Type of CTCP (VERSION, TIME etc)
      * @param sMessage Additional contents
@@ -495,7 +495,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the UnknownCTCPReply Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IUnknownCTCPReply
+     * @see com.dmdirc.parser.interfaces.callbacks.UnknownCtcpReplyListener
      * @param date The date of this line
      * @param sType Type of CTCPRReply (VERSION, TIME etc)
      * @param sMessage Reply Contents
@@ -510,7 +510,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the UnknownMessage Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IUnknownMessage
+     * @see com.dmdirc.parser.interfaces.callbacks.UnknownMessageListener
      * @param date The date of this line
      * @param sMessage Message contents
      * @param sTarget Actual target of message
@@ -524,7 +524,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the UnknownNotice Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IUnknownNotice
+     * @see com.dmdirc.parser.interfaces.callbacks.UnknownNoticeListener
      * @param date The date of this line
      * @param sMessage Notice contents
      * @param sTarget Actual target of notice
@@ -538,7 +538,7 @@ public class ProcessMessage extends TimestampedIRCProcessor {
     /**
      * Callback to all objects implementing the UnknownNotice Callback.
      *
-     * @see com.dmdirc.parser.irc.callbacks.interfaces.IUnknownNotice
+     * @see com.dmdirc.parser.interfaces.callbacks.UnknownServerNoticeListener
      * @param date The date of this line
      * @param sMessage Notice contents
      * @param sTarget Actual target of notice

src/com/dmdirc/parser/irc/ProcessMode.java

@@ -325,7 +325,7 @@ public class ProcessMode extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelModeChanged Callback.
      *
-     * @see IChannelModeChanged
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelModeChangeListener
      * @param cChannel Channel where modes were changed
      * @param cChannelClient Client chaning the modes (null if server)
      * @param sHost Host doing the mode changing (User host or server name)
@@ -339,7 +339,7 @@ public class ProcessMode extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelUserModeChanged Callback.
      *
-     * @see IChannelUserModeChanged
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelUserModeChangeListener
      * @param cChannel Channel where modes were changed
      * @param cChangedClient Client being changed
      * @param cSetByClient Client chaning the modes (null if server)
@@ -354,7 +354,7 @@ public class ProcessMode extends IRCProcessor {
     /**
      * Callback to all objects implementing the UserModeChanged Callback.
      *
-     * @see IUserModeChanged
+     * @see com.dmdirc.parser.interfaces.callbacks.UserModeChangeListener
      * @param cClient Client that had the mode changed (almost always us)
      * @param sSetby Host that set the mode (us or servername)
      * @param sModes The modes set.
@@ -367,7 +367,7 @@ public class ProcessMode extends IRCProcessor {
     /**
      * Callback to all objects implementing the UserModeDiscovered Callback.
      *
-     * @see IUserModeDiscovered
+     * @see com.dmdirc.parser.interfaces.callbacks.UserModeDiscoveryListener
      * @param cClient Client that had the mode changed (almost always us)
      * @param sModes The modes set.
      * @return true if a method was called, false otherwise

src/com/dmdirc/parser/irc/ProcessNames.java

@@ -131,7 +131,7 @@ public class ProcessNames extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelTopic Callback.
      *
-     * @see IChannelTopic
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelTopicListener
      * @param cChannel Channel that topic was set on
      * @param bIsJoinTopic True when getting topic on join, false if set by user/server
      * @return true if a method was called, false otherwise
@@ -144,7 +144,7 @@ public class ProcessNames extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelGotNames Callback.
      *
-     * @see IChannelGotNames
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelNamesListener
      * @param cChannel Channel which the names reply is for
      * @return true if a method was called, false otherwise
      */

src/com/dmdirc/parser/irc/ProcessNick.java

@@ -98,7 +98,7 @@ public class ProcessNick extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelNickChanged Callback.
      *
-     * @see IChannelNickChanged
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelNickChangeListener
      * @param cChannel One of the channels that the user is on
      * @param cChannelClient Client changing nickname
      * @param sOldNick Nickname before change
@@ -111,7 +111,7 @@ public class ProcessNick extends IRCProcessor {
     /**
      * Callback to all objects implementing the NickChanged Callback.
      *
-     * @see INickChanged
+     * @see com.dmdirc.parser.interfaces.callbacks.NickChangeListener
      * @param cClient Client changing nickname
      * @param sOldNick Nickname before change
      * @return true if a method was called, false otherwise

src/com/dmdirc/parser/irc/ProcessNickInUse.java

@@ -85,7 +85,7 @@ public class ProcessNickInUse extends IRCProcessor {
      * Callback to all objects implementing the NickInUse Callback.
      *
      * @param nickname Nickname that was wanted.
-     * @see INickInUse
+     * @see com.dmdirc.parser.interfaces.callbacks.NickInUseListener
      * @return true if a method was called, false otherwise
      */
     protected boolean callNickInUse(final String nickname) {

src/com/dmdirc/parser/irc/ProcessNoticeAuth.java

@@ -53,7 +53,7 @@ public class ProcessNoticeAuth extends IRCProcessor {
     /**
      * Callback to all objects implementing the NoticeAuth Callback.
      *
-     * @see INoticeAuth
+     * @see com.dmdirc.parser.interfaces.callbacks.AuthNoticeListener
      * @param data Incomming Line.
      * @return true if a method was called, false otherwise
      */

src/com/dmdirc/parser/irc/ProcessPart.java

@@ -102,7 +102,7 @@ public class ProcessPart extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelPart Callback.
      *
-     * @see IChannelPart
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelPartListener
      * @param cChannel Channel that the user parted
      * @param cChannelClient Client that parted
      * @param sReason Reason given for parting (May be "")

src/com/dmdirc/parser/irc/ProcessQuit.java

@@ -111,7 +111,7 @@ public class ProcessQuit extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelQuit Callback.
      *
-     * @see IChannelQuit
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelQuitListener
      * @param cChannel Channel that user was on
      * @param cChannelClient User thats quitting
      * @param sReason Quit reason
@@ -124,7 +124,7 @@ public class ProcessQuit extends IRCProcessor {
     /**
      * Callback to all objects implementing the Quit Callback.
      *
-     * @see IQuit
+     * @see com.dmdirc.parser.interfaces.callbacks.QuitListener
      * @param cClient Client Quitting
      * @param sReason Reason for quitting (may be "")
      * @return true if a method was called, false otherwise

src/com/dmdirc/parser/irc/ProcessTopic.java

@@ -93,7 +93,7 @@ public class ProcessTopic extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelTopic Callback.
      *
-     * @see IChannelTopic
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelTopicListener
      * @param cChannel Channel that topic was set on
      * @param bIsJoinTopic True when getting topic on join, false if set by user/server
      * @return true if a method was called, false otherwise

src/com/dmdirc/parser/irc/ProcessWallops.java

@@ -75,7 +75,7 @@ public class ProcessWallops extends IRCProcessor {
     /**
      * Callback to all objects implementing the Wallop Callback.
      *
-     * @see IWallop
+     * @see com.dmdirc.parser.interfaces.callbacks.WallopListener
      * @param host Host of the user who sent the wallop
      * @param message The message
      * @return true if a method was called, false otherwise
@@ -87,7 +87,7 @@ public class ProcessWallops extends IRCProcessor {
     /**
      * Callback to all objects implementing the Walluser Callback.
      *
-     * @see IWalluser
+     * @see com.dmdirc.parser.interfaces.callbacks.WalluserListener
      * @param host Host of the user who sent the walluser
      * @param message The message
      * @return true if a method was called, false otherwise
@@ -99,7 +99,7 @@ public class ProcessWallops extends IRCProcessor {
     /**
      * Callback to all objects implementing the WallDesync Callback.
      *
-     * @see IWallDesync
+     * @see com.dmdirc.parser.interfaces.callbacks.WallDesyncListener
      * @param host Host of the user who sent the WallDesync
      * @param message The message
      * @return true if a method was called, false otherwise

src/com/dmdirc/parser/irc/ProcessWho.java

@@ -97,7 +97,7 @@ public class ProcessWho extends IRCProcessor {
     /**
      * Callback to all objects implementing the onAwayState Callback.
      *
-     * @see IAwayState
+     * @see com.dmdirc.parser.interfaces.callbacks.AwayStateListener
      * @param oldState Old Away State
      * @param currentState Current Away State
      * @param reason Best guess at away reason
@@ -110,7 +110,7 @@ public class ProcessWho extends IRCProcessor {
     /**
      * Callback to all objects implementing the onAwayStateOther Callback.
      *
-     * @see IAwayStateOther
+     * @see com.dmdirc.parser.interfaces.callbacks.OtherAwayStateListener
      * @param client Client this is for
      * @param oldState Old Away State
      * @param state Current Away State
@@ -123,7 +123,7 @@ public class ProcessWho extends IRCProcessor {
     /**
      * Callback to all objects implementing the onChannelAwayStateOther Callback.
      *
-     * @see IAwayStateOther
+     * @see com.dmdirc.parser.interfaces.callbacks.ChannelOtherAwayStateListener
      * @param channel Channel this is for
      * @param channelClient ChannelClient this is for
      * @param oldState Old Away State

src/com/dmdirc/parser/irc/ProcessingManager.java

@@ -237,7 +237,7 @@ public class ProcessingManager {
     /**
      * Callback to all objects implementing the onNumeric Callback.
      *
-     * @see INumeric
+     * @see com.dmdirc.parser.interfaces.callbacks.NumericListener
      * @param numeric What numeric is this for
      * @param token IRC Tokenised line
      * @return true if a method was called, false otherwise

src/com/dmdirc/parser/irc/ServerType.java

@@ -227,8 +227,9 @@ public enum ServerType {
     /**
      * Check if the given mode is op-only.
      *
-     * @param mode
-     * @return
+     * @param mode Mode to check
+     *
+     * @return true if mode is op only
      */
     public boolean isOpOnly(final char mode) {
         return opOnly.indexOf(mode) != -1;