Minor javadoc/style corrections.

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

src/uk/org/ownage/dmdirc/parser/ChannelClientInfo.java

@@ -48,7 +48,7 @@ public class ChannelClientInfo {
 	 * @param tParser Refernce to parser that owns this channelclient (used for modes)
 	 * @param client Client that this channelclient represents
 	 */	
-	public ChannelClientInfo(IRCParser tParser, ClientInfo client) { myParser = tParser; cClient = client; }
+	public ChannelClientInfo(final IRCParser tParser, final ClientInfo client) { myParser = tParser; cClient = client; }
 	
 	/**
 	 * Get the client object represented by this channelclient.
@@ -68,7 +68,7 @@ public class ChannelClientInfo {
 	 *
 	 * @param nNewMode integer representing the modes this client has.
 	 */	
-	public void setChanMode(int nNewMode) { nModes = nNewMode; }
+	public void setChanMode(final int nNewMode) { nModes = nNewMode; }
 	/**
 	 * Get the modes this client has (Prefix modes).
 	 *
@@ -82,17 +82,18 @@ public class ChannelClientInfo {
 	 * getChanModeStr(false).charAt(0) can be used to get the highest mode (o)
 	 * getChanModeStr(true).charAt(0) can be used to get the highest prefix (@)
 	 *
+	 * @param bPrefix if this is true, prefixes will be returned (@+) not modes (ov)
 	 * @return String representing the modes this client has.
 	 */
-	public String getChanModeStr(boolean bPrefix) {
-		String sModes = "", sTemp = "";
+	public String getChanModeStr(final boolean bPrefix) {
+		String sModes = "";
 		Character cTemp;
-		int nTemp = 0, nModes = this.getChanMode();
+		int nTemp = 0, nCurrentModes = this.getChanMode();
 
 //		for (int i = 1; i < myParser.nNextKeyPrefix; i = i*2) {
 		for (int i = myParser.nNextKeyPrefix; i > 0; i = i/2) {
-			if ((nModes & i) == i) {
-				for (Enumeration e = myParser.hPrefixModes.keys(); e.hasMoreElements();) {
+			if ((nCurrentModes & i) == i) {
+				for (final Enumeration e = myParser.hPrefixModes.keys(); e.hasMoreElements();) {
 					cTemp = (Character)e.nextElement();
 					nTemp = myParser.hPrefixModes.get(cTemp);
 					if (nTemp == i) {
@@ -161,9 +162,10 @@ public class ChannelClientInfo {
 	public String toFullString() { return this.getChanModeStr(true)+this.getNickname(); }	
 	
 	/**
-	 * Get SVN Version information
+	 * Get SVN Version information.
 	 *
 	 * @return SVN Version String
 	 */
 	public static String getSvnInfo () { return "$Id$"; }	
 }
+

src/uk/org/ownage/dmdirc/parser/ChannelInfo.java

@@ -24,9 +24,9 @@
 
 package uk.org.ownage.dmdirc.parser;
 
-import java.util.Hashtable;
-import java.util.Enumeration;
 import java.util.ArrayList;
+import java.util.Enumeration;
+import java.util.Hashtable;
 
 /**
  * Contains Channel information.
@@ -61,7 +61,7 @@ public class ChannelInfo {
 	private Hashtable<String,ChannelClientInfo> hChannelUserList = new Hashtable<String,ChannelClientInfo>();
 	/** Hashtable storing values for modes set in the channel that use parameters. */
 	private Hashtable<Character,String> hParamModes = new Hashtable<Character,String>();
-	/** Hashtable storing list modes */
+	/** Hashtable storing list modes. */
 	private Hashtable<Character,ArrayList<String>> hListModes = new Hashtable<Character,ArrayList<String>>();
 
 	/**
@@ -70,7 +70,7 @@ public class ChannelInfo {
 	 * @param tParser Refernce to parser that owns this channelclient (used for modes)	 
 	 * @param name Channel name.
 	 */
-	public ChannelInfo (IRCParser tParser, String name) { myParser = tParser; sName = name; }
+	public ChannelInfo (final IRCParser tParser, final String name) { myParser = tParser; sName = name; }
 	
 	/**
 	 * Get the name of this channel object.
@@ -86,13 +86,13 @@ public class ChannelInfo {
 	public int getUserCount() { return hChannelUserList.size(); }
 	
 	/**
-	 * Get the channel users
+	 * Get the channel users.
 	 *
 	 * @return ArrayList of ChannelClients
 	 */
 	public ArrayList<ChannelClientInfo> getChannelClients() {
 		ArrayList<ChannelClientInfo> lClients = new ArrayList<ChannelClientInfo>();
-		for (Enumeration e = hChannelUserList.keys(); e.hasMoreElements();) {
+		for (final Enumeration e = hChannelUserList.keys(); e.hasMoreElements();) {
 			lClients.add(hChannelUserList.get(e.nextElement()));
 		}
 		return lClients;
@@ -106,6 +106,7 @@ public class ChannelInfo {
 	/**
 	 * Get the ChannelClientInfo object associated with a nickname.
 	 *
+	 * @param sWho Nickname to return channelclient for
 	 * @return ChannelClientInfo object requested, or null if not found
 	 */
 	public ChannelClientInfo getUser(String sWho) {
@@ -116,9 +117,10 @@ public class ChannelInfo {
 	/**
 	 * Get the ChannelClientInfo object associated with a ClientInfo object.
 	 *
+	 * @param cWho ClientInfo to return ChannelClient for
 	 * @return ChannelClientInfo object requested, or null if not found
 	 */	
-	public ChannelClientInfo getUser(ClientInfo cWho) {
+	public ChannelClientInfo getUser(final ClientInfo cWho) {
 		ChannelClientInfo cTemp = null;
 		for (Enumeration e = hChannelUserList.keys(); e.hasMoreElements();) {
 			cTemp = hChannelUserList.get(e.nextElement());
@@ -134,7 +136,7 @@ public class ChannelInfo {
 	 * @param cClient Client object to be added to channel
 	 * @return ChannelClientInfo object added, or an existing object if already known on channel
 	 */		
-	protected ChannelClientInfo addClient(ClientInfo cClient) {
+	protected ChannelClientInfo addClient(final ClientInfo cClient) {
 		ChannelClientInfo cTemp = null;
 		cTemp = getUser(cClient);
 		if (cTemp == null) { 
@@ -149,7 +151,7 @@ public class ChannelInfo {
 	 *
 	 * @param cClient Client object to be removed from channel
 	 */	
-	protected void delClient(ClientInfo cClient) {
+	protected void delClient(final ClientInfo cClient) {
 		ChannelClientInfo cTemp = null;
 		cTemp = getUser(cClient);
 		if (cTemp != null) {
@@ -162,7 +164,7 @@ public class ChannelInfo {
 	 *
 	 * @param nNewTime New unixtimestamp time for the topic (Seconds sinse epoch, not milliseconds)
 	 */
-	public void setTopicTime(long nNewTime) { nTopicTime = nNewTime; }
+	public void setTopicTime(final long nNewTime) { nTopicTime = nNewTime; }
 	/**
 	 * Get the topic time.
 	 *
@@ -175,7 +177,7 @@ public class ChannelInfo {
 	 *
 	 * @param sNewTopic New contents of topic
 	 */	
-	public void setTopic(String sNewTopic) { sTopic = sNewTopic; }
+	public void setTopic(final String sNewTopic) { sTopic = sNewTopic; }
 	/**
 	 * Get the topic.
 	 *
@@ -188,7 +190,7 @@ public class ChannelInfo {
 	 *
 	 * @param sNewUser New user who set the topic (nickname if gotten on connect, full host if seen by parser)
 	 */	
-	public void setTopicUser(String sNewUser) { sTopicUser = sNewUser; }
+	public void setTopicUser(final String sNewUser) { sTopicUser = sNewUser; }
 	/**
 	 * Get the topic creator.
 	 *
@@ -201,7 +203,7 @@ public class ChannelInfo {
 	 *
 	 * @param nNewMode new integer representing channel modes. (Boolean only)
 	 */	
-	public void setMode(int nNewMode) { nModes = nNewMode; }
+	public void setMode(final int nNewMode) { nModes = nNewMode; }
 	/**
 	 * Get the channel modes (as an integer).
 	 *
@@ -217,14 +219,15 @@ public class ChannelInfo {
 	public String getModeStr() { 
 		String sModes = "+", sModeParams = "", sTemp = "";
 		Character cTemp;
-		int nTemp = 0, nModes = this.getMode();
+		int nTemp = 0,
+		final int nChanModes = this.getMode();
 		
-		for (Enumeration e = myParser.hChanModesBool.keys(); e.hasMoreElements();) {
+		for (final Enumeration e = myParser.hChanModesBool.keys(); e.hasMoreElements();) {
 			cTemp = (Character)e.nextElement();
 			nTemp = myParser.hChanModesBool.get(cTemp);
-			if ((nModes & nTemp) == nTemp) { sModes = sModes+cTemp; }
+			if ((nChanModes & nTemp) == nTemp) { sModes = sModes+cTemp; }
 		}
-		for (Enumeration e = hParamModes.keys(); e.hasMoreElements();) {
+		for (final Enumeration e = hParamModes.keys(); e.hasMoreElements();) {
 			cTemp = (Character)e.nextElement();
 			sTemp = hParamModes.get(cTemp);
 			if (!sTemp.equals("")) {
@@ -242,8 +245,8 @@ public class ChannelInfo {
 	 * @param cMode Character representing mode
 	 * @param sValue String repreenting value (if "" mode is unset)
 	 */	
-	public void setModeParam(Character cMode, String sValue) { 
-		if (sValue == "") {
+	public void setModeParam(final Character cMode, final String sValue) { 
+		if (sValue.equals("")) {
 			if (hParamModes.containsKey(cMode)) {
 				hParamModes.remove(cMode);
 			}
@@ -257,7 +260,7 @@ public class ChannelInfo {
 	 * @param cMode Character representing mode
 	 * @return string representing the value of the mode ("" if mode not set)
 	 */	
-	public String getModeParam(Character cMode) { 
+	public String getModeParam(final Character cMode) { 
 		if (hParamModes.containsKey(cMode)) { return hParamModes.get(cMode); }
 		else { return ""; }
 	}
@@ -269,7 +272,7 @@ public class ChannelInfo {
 	 * @param sValue String repreenting value
 	 * @param bAdd Add or remove the value. (true for add, false for remove)
 	 */
-	public void setListModeParam(Character cMode, String sValue, boolean bAdd) { 
+	public void setListModeParam(final Character cMode, final String sValue, final boolean bAdd) { 
 		if (!myParser.hChanModesOther.containsKey(cMode)) { return; }
 		else if (myParser.hChanModesOther.get(cMode) != myParser.cmList) { return; }
 		
@@ -291,7 +294,7 @@ public class ChannelInfo {
 	 * @param cMode Character representing mode
 	 * @return ArrayList containing items in the list, or null if mode is invalid
 	 */
-	public ArrayList setListModeParam(Character cMode) { 
+	public ArrayList setListModeParam(final Character cMode) { 
 		if (!myParser.hChanModesOther.containsKey(cMode)) { return null; }
 		else if (myParser.hChanModesOther.get(cMode) != myParser.cmList) { return null; }
 		
@@ -304,7 +307,7 @@ public class ChannelInfo {
 	 *
 	 * @param sMessage Message to send
 	 */
-	public void sendMessage(String sMessage) { 
+	public void sendMessage(final String sMessage) { 
 		if (sMessage.equals("")) { return; }
 		
 		myParser.sendString("PRIVMSG "+sName+" :"+sMessage);	
@@ -315,7 +318,7 @@ public class ChannelInfo {
 	 *
 	 * @param sMessage Message to send
 	 */
-	public void sendNotice(String sMessage) { 
+	public void sendNotice(final String sMessage) { 
 		if (sMessage.equals("")) { return; }
 		
 		myParser.sendString("NOTICE "+sName+" :"+sMessage);	
@@ -326,7 +329,7 @@ public class ChannelInfo {
 	 *
 	 * @param sMessage Message to send
 	 */
-	public void sendAction(String sMessage) { 
+	public void sendAction(final String sMessage) { 
 		if (sMessage.equals("")) { return; }
 		sendCTCP("ACTION", sMessage);
 	}
@@ -337,11 +340,11 @@ public class ChannelInfo {
 	 * @param sType Type of CTCP
 	 * @param sMessage Optional Additional Parameters
 	 */
-	public void sendCTCP(String sType, String sMessage) { 
+	public void sendCTCP(final String sType, final String sMessage) { 
 		if (sType.equals("")) { return; }
-		Character Char1 = Character.valueOf((char)1);
+		final Character char1 = Character.valueOf((char)1);
 		if (!sMessage.equals("")) { sMessage = " "+sMessage; }
-		myParser.sendString("PRIVMSG "+sName+" :"+Char1+sType.toUpperCase()+sMessage+Char1);	
+		myParser.sendString("PRIVMSG "+sName+" :"+char1+sType.toUpperCase()+sMessage+char1);	
 	}
 	
 	/**
@@ -350,15 +353,15 @@ public class ChannelInfo {
 	 * @param sType Type of CTCP
 	 * @param sMessage Optional Additional Parameters
 	 */
-	public void sendCTCPReply(String sType, String sMessage) { 
+	public void sendCTCPReply(final String sType, final String sMessage) { 
 		if (sType.equals("")) { return; }
-		Character Char1 = Character.valueOf((char)1);
+		final Character char1 = Character.valueOf((char)1);
 		if (!sMessage.equals("")) { sMessage = " "+sMessage; }
-		myParser.sendString("NOTICE "+sName+" :"+Char1+sType.toUpperCase()+sMessage+Char1);	
+		myParser.sendString("NOTICE "+sName+" :"+char1+sType.toUpperCase()+sMessage+char1);	
 	}
 	
 	/**
-	 * Get a string representation of the Channel
+	 * Get a string representation of the Channel.
 	 *
 	 * @return String representation of the Channel.
 	 */
@@ -371,3 +374,4 @@ public class ChannelInfo {
 	 */
 	public static String getSvnInfo () { return "$Id$"; }	
 }
+

src/uk/org/ownage/dmdirc/parser/ClientInfo.java

@@ -52,9 +52,10 @@ public class ClientInfo {
 	 * Get a nickname of a user from a hostmask.
 	 * Hostmask must match (?:)nick(?!ident)(?@host)
 	 *
+	 * @param sWho Hostname to parse
 	 * @return nickname of user
 	 */
-	public static String parseHost(String sWho) {
+	public static String parseHost(final String sWho) {
 		// Get the nickname from the string.
 		return parseHostFull(sWho)[0];
 	}
@@ -63,9 +64,10 @@ public class ClientInfo {
 	 * Get a nick ident and host of a user from a hostmask.
 	 * Hostmask must match (?:)nick(?!ident)(?@host)
 	 *
+	 * @param sWho Hostname to parse
 	 * @return Array containing details. (result[0] -> Nick | result[1] -> Ident | result[2] -> Host)
 	 */
-	public static String[] parseHostFull(String sWho) {
+	public static String[] parseHostFull(final String sWho) {
 		String sTemp[] = null;
 		String result[] = new String[3];
 		sTemp = sWho.split(":",2);
@@ -87,17 +89,17 @@ public class ClientInfo {
 	 * @param sHostmask Hostmask parsed by parseHost to get nickname
 	 * @see ClientInfo#parseHost
 	 */
-	public ClientInfo (IRCParser tParser, String sHostmask) { 
+	public ClientInfo (final IRCParser tParser, final String sHostmask) { 
 		setUserBits(sHostmask,true);
 		myParser = tParser;
 	}
 	/**
-	 * Get a string representation of the user
+	 * Get a string representation of the user.
 	 *
 	 * @param sHostmask takes a host (?:)nick(?!ident)(?@host) and sets nick/host/ident variables
 	 * @param bUpdateNick if this is false, only host/ident will be updated.
 	 */	
-	public void setUserBits (String sHostmask, boolean bUpdateNick) {
+	public void setUserBits (final String sHostmask, final boolean bUpdateNick) {
 		String sTemp[] = parseHostFull(sHostmask);
 		if (!sTemp[2].equals("")) { sHost = sTemp[2]; }
 		if (!sTemp[1].equals("")) { sIdent = sTemp[1]; }
@@ -105,26 +107,26 @@ public class ClientInfo {
 	}
 	
 	/**
-	 * Get a string representation of the user
+	 * Get a string representation of the user.
 	 *
 	 * @return String representation of the user.
 	 */
 	public String toString() { return sNickname+"!"+sIdent+"@"+sHost; }
 	
 	/**
-	 * Get the nickname for this user
+	 * Get the nickname for this user.
 	 *
 	 * @return Known nickname for user.
 	 */
 	public String getNickname() { return sNickname; }
 	/**
-	 * Get the ident for this user
+	 * Get the ident for this user.
 	 *
 	 * @return Known ident for user. (May be "")
 	 */		
 	public String getIdent() { return sIdent; }
 	/**
-	 * Get the hostname for this user
+	 * Get the hostname for this user.
 	 *
 	 * @return Known host for user. (May be "")
 	 */		
@@ -135,7 +137,7 @@ public class ClientInfo {
 	 *
 	 * @param bNewState Boolean representing state. true = away, false = here
 	 */	
-	public void setAwayState(boolean bNewState) { bIsAway = bNewState; }
+	public void setAwayState(final boolean bNewState) { bIsAway = bNewState; }
 	/**
 	 * Get the away state of a user.
 	 *
@@ -148,7 +150,7 @@ public class ClientInfo {
 	 *
 	 * @param nNewMode new integer representing channel modes. (Boolean only)
 	 */	
-	public void setUserMode(int nNewMode) { nModes = nNewMode; }
+	public void setUserMode(final int nNewMode) { nModes = nNewMode; }
 	/**
 	 * Get the user modes (as an integer).
 	 *
@@ -164,12 +166,13 @@ public class ClientInfo {
 	public String getUserModeStr() { 
 		String sModes = "+", sTemp = "";
 		Character cTemp;
-		int nTemp = 0, nModes = this.getUserMode();
+		int nTemp = 0;
+		final int nChanModes = this.getUserMode();
 		
-		for (Enumeration e = myParser.hUserModes.keys(); e.hasMoreElements();) {
+		for (final Enumeration e = myParser.hUserModes.keys(); e.hasMoreElements();) {
 			cTemp = (Character)e.nextElement();
 			nTemp = myParser.hUserModes.get(cTemp);
-			if ((nModes & nTemp) == nTemp) { sModes = sModes+cTemp; }
+			if ((nChanModes & nTemp) == nTemp) { sModes = sModes+cTemp; }
 		}
 		
 		return sModes;
@@ -195,7 +198,7 @@ public class ClientInfo {
 	}
 	
 	/**
-	 * Get SVN Version information
+	 * Get SVN Version information.
 	 *
 	 * @return SVN Version String
 	 */

src/uk/org/ownage/dmdirc/parser/IRCParser.java

@@ -23,32 +23,32 @@
  */
 
 package uk.org.ownage.dmdirc.parser;
-import uk.org.ownage.dmdirc.parser.callbacks.interfaces.IDataIn;
-import uk.org.ownage.dmdirc.parser.callbacks.interfaces.IDataOut;
-import uk.org.ownage.dmdirc.parser.callbacks.interfaces.IDebugInfo;
-import uk.org.ownage.dmdirc.parser.callbacks.interfaces.IErrorInfo;
-import uk.org.ownage.dmdirc.parser.callbacks.interfaces.ISocketClosed;
+
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackOnDataIn;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackOnDataOut;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackOnDebugInfo;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackOnErrorInfo;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackOnSocketClosed;
+import uk.org.ownage.dmdirc.parser.callbacks.interfaces.IDataIn;
+import uk.org.ownage.dmdirc.parser.callbacks.interfaces.IDataOut;
+import uk.org.ownage.dmdirc.parser.callbacks.interfaces.IDebugInfo;
+import uk.org.ownage.dmdirc.parser.callbacks.interfaces.IErrorInfo;
+import uk.org.ownage.dmdirc.parser.callbacks.interfaces.ISocketClosed;
 import java.io.BufferedReader;
-import java.io.IOException;
 import java.io.InputStreamReader;
+import java.io.IOException;
 import java.io.PrintWriter;
 import java.net.Socket;
 import java.net.UnknownHostException;
+import java.util.Arrays;
+import java.util.Enumeration;
+import java.util.Hashtable;
+import javax.net.SocketFactory;
 import javax.net.ssl.SSLContext;
-import javax.net.ssl.SSLSocketFactory;
 import javax.net.ssl.SSLSocket;
 import javax.net.ssl.X509TrustManager;
 import javax.net.ssl.TrustManager;
-import javax.net.SocketFactory;
-import java.util.Arrays;
-import java.util.Hashtable;
-import java.util.Enumeration;
 
 /**
  * IRC Parser.
@@ -240,6 +240,7 @@ public class IRCParser implements Runnable {
 	 *
 	 * @see IDataIn
 	 * @param data Incomming Line.
+	 * @return true if a method was called, false otherwise
 	 */
 	protected boolean callDataIn(String data) {
 		CallbackOnDataIn cb = (CallbackOnDataIn)myCallbackManager.getCallbackType("OnDataIn");
@@ -253,6 +254,7 @@ public class IRCParser implements Runnable {
 	 * @see IDataOut
 	 * @param data Outgoing Data
 	 * @param FromParser True if parser sent the data, false if sent using .sendLine
+	 * @return true if a method was called, false otherwise
 	 */
 	protected boolean callDataOut(String data, boolean FromParser) {
 		CallbackOnDataOut cb = (CallbackOnDataOut)myCallbackManager.getCallbackType("OnDataOut");
@@ -267,6 +269,7 @@ public class IRCParser implements Runnable {
 	 * @param level Debugging Level (ndInfo, ndSocket etc)
 	 * @param data Debugging Information as a format string
 	 * @param args Formatting String Options
+	 * @return true if a method was called, false otherwise
 	 */
 	protected boolean callDebugInfo(int level, String data, Object... args) {
 		return callDebugInfo(level, String.format(data, args));
@@ -277,6 +280,7 @@ public class IRCParser implements Runnable {
 	 * @see IDebugInfo
 	 * @param level Debugging Level (ndInfo, ndSocket etc)
 	 * @param data Debugging Information
+	 * @return true if a method was called, false otherwise
 	 */
 	protected boolean callDebugInfo(int level, String data) {
 		CallbackOnDebugInfo cb = (CallbackOnDebugInfo)myCallbackManager.getCallbackType("OnDebugInfo");
@@ -289,6 +293,7 @@ public class IRCParser implements Runnable {
 	 *
 	 * @see IErrorInfo
 	 * @param errorInfo ParserError object representing the error.
+	 * @return true if a method was called, false otherwise
 	 */
 	protected boolean callErrorInfo(ParserError errorInfo) {
 		CallbackOnErrorInfo cb = (CallbackOnErrorInfo)myCallbackManager.getCallbackType("OnErrorInfo");
@@ -300,6 +305,7 @@ public class IRCParser implements Runnable {
 	 * Callback to all objects implementing the SocketClosed Callback.
 	 *
 	 * @see ISocketClosed
+	 * @return true if a method was called, false otherwise
 	 */	
 	protected boolean callSocketClosed() {
 		CallbackOnSocketClosed cb = (CallbackOnSocketClosed)myCallbackManager.getCallbackType("OnSocketClosed");
@@ -360,7 +366,11 @@ public class IRCParser implements Runnable {
 	}
 
 	
-	/** Connect to IRC. */
+	/**
+	 * Connect to IRC.
+	 *
+	 * @throws Exception if there was an error setting up the socket
+	 */
 	private void connect() throws Exception {
 		try {
 			resetState();
@@ -954,6 +964,7 @@ public class IRCParser implements Runnable {
 	 * Check if a channel name is valid.
 	 *
 	 * @param sChannelName Channel name to test
+	 * @return true if name is valid on the current connection, false otherwise. (Always false before noMOTD/MOTDEnd)
 	 */
 	public boolean isValidChannelName(String sChannelName) {
 		return hChanPrefix.containsKey(sChannelName.charAt(0));
@@ -967,9 +978,9 @@ public class IRCParser implements Runnable {
 	public ClientInfo getMyself() { return cMyself; }
 	
 	/**
-	 * Get SVN Version information
+	 * Get SVN Version information.
 	 *
 	 * @return SVN Version String
 	 */
 	public static String getSvnInfo () { return "$Id$"; }	
-}
+}

src/uk/org/ownage/dmdirc/parser/IRCProcessor.java

@@ -178,4 +178,4 @@ public abstract class IRCProcessor {
 	 * @return SVN Version String
 	 */
 	public static String getSvnInfo () { return "$Id$"; }	
-}
+}

src/uk/org/ownage/dmdirc/parser/ParserError.java

@@ -141,5 +141,3 @@ public class ParserError {
 	 */
 	public static String getSvnInfo () { return "$Id$"; }	
 }
-
-// eof

src/uk/org/ownage/dmdirc/parser/Process001.java

@@ -89,4 +89,4 @@ public class Process001 extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected Process001 (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/Process004005.java

@@ -74,4 +74,4 @@ public class Process004005 extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected Process004005 (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/Process464.java

@@ -60,4 +60,4 @@ public class Process464 extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected Process464 (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessAway.java

@@ -60,4 +60,4 @@ public class ProcessAway extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected ProcessAway (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessJoin.java

@@ -123,4 +123,4 @@ public class ProcessJoin extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected ProcessJoin (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessKick.java

@@ -114,4 +114,4 @@ public class ProcessKick extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected ProcessKick (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessMOTD.java

@@ -112,4 +112,4 @@ public class ProcessMOTD extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected ProcessMOTD (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessMessage.java

@@ -431,4 +431,4 @@ public class ProcessMessage extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected ProcessMessage (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessMode.java

@@ -309,4 +309,4 @@ public class ProcessMode extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected ProcessMode (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessNames.java

@@ -129,4 +129,4 @@ public class ProcessNames extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected ProcessNames (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessNick.java

@@ -112,4 +112,4 @@ public class ProcessNick extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected ProcessNick (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessNickInUse.java

@@ -94,4 +94,4 @@ public class ProcessNickInUse extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected ProcessNickInUse (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessNoticeAuth.java

@@ -71,4 +71,4 @@ public class ProcessNoticeAuth extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected ProcessNoticeAuth (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessPart.java

@@ -108,4 +108,4 @@ public class ProcessPart extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected ProcessPart (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessQuit.java

@@ -125,4 +125,4 @@ public class ProcessQuit extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected ProcessQuit (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessTopic.java

@@ -101,4 +101,4 @@ public class ProcessTopic extends IRCProcessor {
 	 * @param manager ProcessingManager that is in charge of this IRCProcessor
 	 */
 	protected ProcessTopic (IRCParser parser, ProcessingManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/ProcessorNotFound.java

@@ -44,4 +44,4 @@ public class ProcessorNotFound extends Exception {
 	 * @param message Reason for exception
 	 */
 	public ProcessorNotFound(String message) { super(message); }
-}
+}

src/uk/org/ownage/dmdirc/parser/RegexStringList.java

@@ -125,4 +125,4 @@ public class RegexStringList {
 	public int count() {
 		return ignoreInfo.size();
 	}
-}
+}

src/uk/org/ownage/dmdirc/parser/ServerInfo.java

@@ -61,3 +61,4 @@ public class ServerInfo {
 	 */
 	public static String getSvnInfo () { return "$Id$"; }	
 }
+

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackNotFound.java

@@ -43,5 +43,5 @@ public class CallbackNotFound extends Exception {
 	 *
 	 * @param message Reason for exception
 	 */
-	public CallbackNotFound(String message) { super(message); }
+	public CallbackNotFound(final String message) { super(message); }
 }

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackObject.java

@@ -102,7 +102,11 @@ public abstract class CallbackObject {
 	 */
 	public void del(ICallbackInterface eMethod) { delCallback(eMethod); }
 	
-	/** Get the name for this callback */
+	/**
+	 * Get the name for this callback
+	 *
+	 * @return Name of callback
+	 */
 	public String getName() {
 		Package thisPackage = this.getClass().getPackage();
 		int packageLength = 0;
@@ -112,7 +116,11 @@ public abstract class CallbackObject {
 		return this.getClass().getName().substring(packageLength+8); // 8 is the length of "Callback"
 	}
 	
-	/** Get the name for this callback in lowercase */
+	/**
+	 * Get the name for this callback in lowercase.
+	 *
+	 * @return Name of callback, in lowercase
+	 */
 	public final String getLowerName() {
 		return this.getName().toLowerCase();
 	}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackObjectSpecific.java

@@ -45,6 +45,7 @@ public abstract class CallbackObjectSpecific extends CallbackObject {
 	 * 
 	 * @param eMethod Object that is being called back to
 	 * @param cChannel ChannelInfo object for the channel to test
+	 * @return true if channel given matches the specifics for the method given
 	 */
 	protected boolean isValidChan(ICallbackInterface eMethod, ChannelInfo cChannel) {
 		if (specificData.containsKey(eMethod)) { 
@@ -58,6 +59,7 @@ public abstract class CallbackObjectSpecific extends CallbackObject {
 	 * 
 	 * @param eMethod Object that is being called back to
 	 * @param sHost Hostname of user that sent the query
+	 * @return true if host given matches the specifics for the method given
 	 */
 	protected boolean isValidUser(ICallbackInterface eMethod, String sHost) {
 		String nickname = ClientInfo.parseHost(sHost);

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelAction.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelAction;
 
+/**
+ * Callback to all objects implementing the IChannelAction Interface.
+ */
 public class CallbackOnChannelAction extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelAction Interface.
@@ -37,6 +40,7 @@ public class CallbackOnChannelAction extends CallbackObjectSpecific {
 	 * @param cChannelClient ChannelClient who sent the action (may be null if server)
 	 * @param sMessage action contents
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sMessage, String sHost) {
 		boolean bResult = false;
@@ -63,4 +67,4 @@ public class CallbackOnChannelAction extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelAction (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelCTCP.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelCTCP;
 
+/**
+ * Callback to all objects implementing the IChannelCTCP Interface.
+ */
 public class CallbackOnChannelCTCP extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelCTCP Interface.
@@ -38,6 +41,7 @@ public class CallbackOnChannelCTCP extends CallbackObjectSpecific {
 	 * @param sType Type of CTCP (VERSION, TIME etc)
 	 * @param sMessage Additional contents
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sType, String sMessage, String sHost) {
 		boolean bResult = false;
@@ -64,4 +68,4 @@ public class CallbackOnChannelCTCP extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelCTCP (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelCTCPReply.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelCTCPReply;
 
+/**
+ * Callback to all objects implementing the IChannelCTCPReply Interface.
+ */
 public class CallbackOnChannelCTCPReply extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelCTCPReply Interface.
@@ -38,6 +41,7 @@ public class CallbackOnChannelCTCPReply extends CallbackObjectSpecific {
 	 * @param sType Type of CTCPRReply (VERSION, TIME etc)
 	 * @param sMessage Reply Contents
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sType, String sMessage, String sHost) {
 		boolean bResult = false;
@@ -64,4 +68,4 @@ public class CallbackOnChannelCTCPReply extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelCTCPReply (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelGotNames.java

@@ -28,12 +28,16 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelGotNames;
 
+/**
+ * Callback to all objects implementing the IChannelGotNames Interface.
+ */
 public class CallbackOnChannelGotNames extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelGotNames Interface.
 	 *
 	 * @see IChannelGotNames
 	 * @param cChannel Channel which the names reply is for
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel) {
 		boolean bResult = false;
@@ -60,4 +64,4 @@ public class CallbackOnChannelGotNames extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelGotNames (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelJoin.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelJoin;
 
+/**
+ * Callback to all objects implementing the IChannelJoin Interface.
+ */
 public class CallbackOnChannelJoin extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelJoin Interface.
@@ -35,6 +38,7 @@ public class CallbackOnChannelJoin extends CallbackObjectSpecific {
 	 * @see IChannelJoin
 	 * @param cChannel Channel Object
 	 * @param cChannelClient ChannelClient object for new person
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cChannelClient) {
 		boolean bResult = false;
@@ -61,4 +65,4 @@ public class CallbackOnChannelJoin extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelJoin (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelKick.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelKick;
 
+/**
+ * Callback to all objects implementing the IChannelKick Interface.
+ */
 public class CallbackOnChannelKick extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelKick Interface.
@@ -38,6 +41,7 @@ public class CallbackOnChannelKick extends CallbackObjectSpecific {
 	 * @param cKickedByClient ChannelClient that did the kicking (may be null if server)
 	 * @param sReason Reason for kick (may be "")
 	 * @param sKickedByHost Hostname of Kicker (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cKickedClient, ChannelClientInfo cKickedByClient, String sReason, String sKickedByHost) {
 		boolean bResult = false;
@@ -64,4 +68,4 @@ public class CallbackOnChannelKick extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelKick (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelMessage.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelMessage;
 
+/**
+ * Callback to all objects implementing the IChannelMessage Interface.
+ */
 public class CallbackOnChannelMessage extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelMessage Interface.
@@ -37,6 +40,7 @@ public class CallbackOnChannelMessage extends CallbackObjectSpecific {
 	 * @param cChannelClient ChannelClient who sent the message (may be null if server)
 	 * @param sMessage Message contents
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sMessage, String sHost) {
 		boolean bResult = false;
@@ -63,4 +67,4 @@ public class CallbackOnChannelMessage extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelMessage (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelModeChanged.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelModeChanged;
 
+/**
+ * Callback to all objects implementing the IChannelModeChanged Interface.
+ */
 public class CallbackOnChannelModeChanged extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelModeChanged Interface.
@@ -37,6 +40,7 @@ public class CallbackOnChannelModeChanged extends CallbackObjectSpecific {
 	 * @param cChannelClient Client chaning the modes (null if server)
 	 * @param sHost Host doing the mode changing (User host or server name)
 	 * @param sModes Exact String parsed
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sHost, String sModes) {
 		boolean bResult = false;
@@ -63,4 +67,4 @@ public class CallbackOnChannelModeChanged extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelModeChanged (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelNickChanged.java

@@ -27,7 +27,9 @@ package uk.org.ownage.dmdirc.parser.callbacks;
 import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelNickChanged;
-
+/**
+ * Callback to all objects implementing the IChannelNickChanged Interface.
+ */
 public class CallbackOnChannelNickChanged extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelNickChanged Interface.
@@ -36,6 +38,7 @@ public class CallbackOnChannelNickChanged extends CallbackObjectSpecific {
 	 * @param cChannel One of the channels that the user is on
 	 * @param cChannelClient Client changing nickname
 	 * @param sOldNick Nickname before change
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sOldNick) {
 		boolean bResult = false;
@@ -62,4 +65,4 @@ public class CallbackOnChannelNickChanged extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelNickChanged (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelNonUserModeChanged.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelNonUserModeChanged;
 
+/**
+ * Callback to all objects implementing the IChannelNonUserModeChanged Interface.
+ */
 public class CallbackOnChannelNonUserModeChanged extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelNonUserModeChanged Interface.
@@ -37,6 +40,7 @@ public class CallbackOnChannelNonUserModeChanged extends CallbackObjectSpecific
 	 * @param cChannelClient Client changing the modes (null if server)
 	 * @param sHost Host doing the mode changing (User host or server name)
 	 * @param sModes Exact String parsed (not including user modes)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sHost, String sModes) {
 		boolean bResult = false;
@@ -63,4 +67,4 @@ public class CallbackOnChannelNonUserModeChanged extends CallbackObjectSpecific
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelNonUserModeChanged (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelNotice.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelNotice;
 
+/**
+ * Callback to all objects implementing the IChannelNotice Interface.
+ */
 public class CallbackOnChannelNotice extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelNotice Interface.
@@ -37,6 +40,7 @@ public class CallbackOnChannelNotice extends CallbackObjectSpecific {
 	 * @param cChannelClient ChannelClient who sent the notice (may be null if server)
 	 * @param sMessage notice contents
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sMessage, String sHost) {
 		boolean bResult = false;
@@ -64,4 +68,4 @@ public class CallbackOnChannelNotice extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelNotice (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelPart.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelPart;
 
+/**
+ * Callback to all objects implementing the IChannelPart Interface.
+ */
 public class CallbackOnChannelPart extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelPart Interface.
@@ -36,6 +39,7 @@ public class CallbackOnChannelPart extends CallbackObjectSpecific {
 	 * @param cChannel Channel that the user parted
 	 * @param cChannelClient Client that parted
 	 * @param sReason Reason given for parting (May be "")
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sReason) {
 		boolean bResult = false;
@@ -62,4 +66,4 @@ public class CallbackOnChannelPart extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelPart (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelQuit.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelQuit;
 
+/**
+ * Callback to all objects implementing the IChannelQuit Interface.
+ */
 public class CallbackOnChannelQuit extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelQuit Interface.
@@ -36,6 +39,7 @@ public class CallbackOnChannelQuit extends CallbackObjectSpecific {
 	 * @param cChannel Channel that user was on
 	 * @param cChannelClient User thats quitting
 	 * @param sReason Quit reason
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sReason) {
 		boolean bResult = false;
@@ -62,4 +66,4 @@ public class CallbackOnChannelQuit extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelQuit (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelSelfJoin.java

@@ -28,12 +28,16 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelSelfJoin;
 
+/**
+ * Callback to all objects implementing the IChannelSelfJoin Interface.
+ */
 public class CallbackOnChannelSelfJoin extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IChannelSelfJoin Interface.
 	 *
 	 * @see IChannelSelfJoin
 	 * @param cChannel Channel Object
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel) {
 		boolean bResult = false;
@@ -57,4 +61,4 @@ public class CallbackOnChannelSelfJoin extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelSelfJoin (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelSingleModeChanged.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelSingleModeChanged;
 
+/**
+ * Callback to all objects implementing the IChannelSingleModeChanged Interface.
+ */
 public class CallbackOnChannelSingleModeChanged extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelSingleModeChanged Interface.
@@ -37,6 +40,7 @@ public class CallbackOnChannelSingleModeChanged extends CallbackObjectSpecific {
 	 * @param cChannelClient Client chaning the modes (null if server)
 	 * @param sHost Host doing the mode changing (User host or server name)
 	 * @param sModes String parsed (ie "+m" or "+k moo"
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sHost, String sModes) {
 		boolean bResult = false;
@@ -63,4 +67,4 @@ public class CallbackOnChannelSingleModeChanged extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelSingleModeChanged (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelTopic.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelTopic;
 
+/**
+ * Callback to all objects implementing the IChannelTopic Interface.
+ */
 public class CallbackOnChannelTopic extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelTopic Interface.
@@ -35,6 +38,7 @@ public class CallbackOnChannelTopic extends CallbackObjectSpecific {
 	 * @see IChannelTopic
 	 * @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 callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, boolean bIsJoinTopic) {
 		boolean bResult = false;
@@ -61,4 +65,4 @@ public class CallbackOnChannelTopic extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelTopic (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnChannelUserModeChanged.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IChannelUserModeChanged;
 
+/**
+ * Callback to all objects implementing the IChannelUserModeChanged Interface.
+ */
 public class CallbackOnChannelUserModeChanged extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IChannelUserModeChanged Interface.
@@ -38,6 +41,7 @@ public class CallbackOnChannelUserModeChanged extends CallbackObjectSpecific {
 	 * @param cSetByClient Client chaning the modes (null if server)
 	 * @param sMode String representing mode change (ie +o)
 	 * @param sHost Host doing the mode changing (User host or server name)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ChannelInfo cChannel, ChannelClientInfo cChangedClient, ChannelClientInfo cSetByClient, String sHost, String sMode) {
 		boolean bResult = false;
@@ -64,4 +68,4 @@ public class CallbackOnChannelUserModeChanged extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnChannelUserModeChanged (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnDataIn.java

@@ -28,12 +28,16 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IDataIn;
 
+/**
+ * Callback to all objects implementing the IDataIn Interface.
+ */
 public class CallbackOnDataIn extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IDataIn Interface.
 	 *
 	 * @see IDataIn
 	 * @param data Incomming Line.
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String data) {
 		boolean bResult = false;
@@ -57,4 +61,4 @@ public class CallbackOnDataIn extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnDataIn (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnDataOut.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IDataOut;
 
+/**
+ * Callback to all objects implementing the IDataOut Interface.
+ */
 public class CallbackOnDataOut extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IDataOut Interface.
@@ -35,6 +38,7 @@ public class CallbackOnDataOut extends CallbackObject {
 	 * @see IDataOut
 	 * @param data Outgoing Data
 	 * @param FromParser True if parser sent the data, false if sent using .sendLine	 
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String data, boolean FromParser) {
 		boolean bResult = false;
@@ -58,4 +62,4 @@ public class CallbackOnDataOut extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnDataOut (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnDebugInfo.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IDebugInfo;
 
+/**
+ * Callback to all objects implementing the IDebugInfo Interface.
+ */
 public class CallbackOnDebugInfo extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IDebugInfo Interface.
@@ -35,6 +38,7 @@ public class CallbackOnDebugInfo extends CallbackObject {
 	 * @see IDebugInfo
 	 * @param level Debugging Level (ndInfo, ndSocket etc)
 	 * @param data Debugging Information
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(int level, String data) {
 		boolean bResult = false;
@@ -58,4 +62,4 @@ public class CallbackOnDebugInfo extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnDebugInfo (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnErrorInfo.java

@@ -28,12 +28,16 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IErrorInfo;
 
+/**
+ * Callback to all objects implementing the IErrorInfo Interface.
+ */
 public class CallbackOnErrorInfo extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IErrorInfo Interface.
 	 *
 	 * @see IErrorInfo
 	 * @param errorInfo ParserError object representing the error.
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ParserError errorInfo) {
 		boolean bResult = false;
@@ -57,4 +61,4 @@ public class CallbackOnErrorInfo extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnErrorInfo (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnMOTDEnd.java

@@ -28,11 +28,15 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IMOTDEnd;
 
+/**
+ * Callback to all objects implementing the IMotdEnd Interface.
+ */
 public class CallbackOnMOTDEnd extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IMotdEnd Interface.
 	 *
 	 * @see IMOTDEnd
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(boolean noMOTD) {
 		boolean bResult = false;
@@ -56,4 +60,4 @@ public class CallbackOnMOTDEnd extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnMOTDEnd (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnMOTDLine.java

@@ -28,12 +28,16 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IMOTDLine;
 
+/**
+ * Callback to all objects implementing the IMOTDLine Interface.
+ */
 public class CallbackOnMOTDLine extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IMOTDLine Interface.
 	 *
 	 * @see IMOTDLine
 	 * @param data Incomming Line.
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String data) {
 		boolean bResult = false;
@@ -57,4 +61,4 @@ public class CallbackOnMOTDLine extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnMOTDLine (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnMOTDStart.java

@@ -28,12 +28,16 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IMOTDStart;
 
+/**
+ * Callback to all objects implementing the IMOTDStart Interface.
+ */
 public class CallbackOnMOTDStart extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IMOTDStart Interface.
 	 *
 	 * @see IMOTDStart
 	 * @param data Incomming Line.
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String data) {
 		boolean bResult = false;
@@ -57,4 +61,4 @@ public class CallbackOnMOTDStart extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnMOTDStart (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnNickChanged.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.INickChanged;
 
+/**
+ * Callback to all objects implementing the INickChanged Interface.
+ */
 public class CallbackOnNickChanged extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the INickChanged Interface.
@@ -35,6 +38,7 @@ public class CallbackOnNickChanged extends CallbackObject {
 	 * @see INickChanged
 	 * @param cClient Client changing nickname
 	 * @param sOldNick Nickname before change
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ClientInfo cClient, String sOldNick) {
 		boolean bResult = false;
@@ -58,4 +62,4 @@ public class CallbackOnNickChanged extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnNickChanged (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnNickInUse.java

@@ -28,11 +28,15 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.INickInUse;
 
+/**
+ * Callback to all objects implementing the INickInUse Interface.
+ */
 public class CallbackOnNickInUse extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the INickInUse Interface.
 	 *
 	 * @see INickInUse
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call() {
 		boolean bResult = false;
@@ -56,4 +60,4 @@ public class CallbackOnNickInUse extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnNickInUse (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnNoticeAuth.java

@@ -28,12 +28,16 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.INoticeAuth;
 
+/**
+ * Callback to all objects implementing the INoticeAuth Interface.
+ */
 public class CallbackOnNoticeAuth extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the INoticeAuth Interface.
 	 *
 	 * @see INoticeAuth
 	 * @param data Incomming Line.
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String data) {
 		boolean bResult = false;
@@ -57,4 +61,4 @@ public class CallbackOnNoticeAuth extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnNoticeAuth (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnPrivateAction.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IPrivateAction;
 
+/**
+ * Callback to all objects implementing the IPrivateAction Interface.
+ */
 public class CallbackOnPrivateAction extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IPrivateAction Interface.
@@ -35,6 +38,7 @@ public class CallbackOnPrivateAction extends CallbackObjectSpecific {
 	 * @see IPrivateAction
 	 * @param sMessage action contents
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String sMessage, String sHost) {
 		boolean bResult = false;
@@ -61,4 +65,4 @@ public class CallbackOnPrivateAction extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnPrivateAction (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnPrivateCTCP.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IPrivateCTCP;
 
+/**
+ * Callback to all objects implementing the IPrivateCTCP Interface.
+ */
 public class CallbackOnPrivateCTCP extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IPrivateCTCP Interface.
@@ -36,6 +39,7 @@ public class CallbackOnPrivateCTCP extends CallbackObjectSpecific {
 	 * @param sType Type of CTCP (VERSION, TIME etc)
 	 * @param sMessage Additional contents
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String sType, String sMessage, String sHost) {
 		boolean bResult = false;
@@ -62,4 +66,4 @@ public class CallbackOnPrivateCTCP extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnPrivateCTCP (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnPrivateCTCPReply.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IPrivateCTCPReply;
 
+/**
+ * Callback to all objects implementing the IPrivateCTCPReply Interface.
+ */
 public class CallbackOnPrivateCTCPReply extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IPrivateCTCPReply Interface.
@@ -36,6 +39,7 @@ public class CallbackOnPrivateCTCPReply extends CallbackObjectSpecific {
 	 * @param sType Type of CTCPRReply (VERSION, TIME etc)
 	 * @param sMessage Reply Contents
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String sType, String sMessage, String sHost) {
 		boolean bResult = false;
@@ -62,4 +66,4 @@ public class CallbackOnPrivateCTCPReply extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnPrivateCTCPReply (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnPrivateMessage.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IPrivateMessage;
 
+/**
+ * Callback to all objects implementing the IPrivateMessage Interface.
+ */
 public class CallbackOnPrivateMessage extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IPrivateMessage Interface.
@@ -35,6 +38,7 @@ public class CallbackOnPrivateMessage extends CallbackObjectSpecific {
 	 * @see IPrivateMessage
 	 * @param sMessage Message contents
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String sMessage, String sHost) {
 		boolean bResult = false;
@@ -61,4 +65,4 @@ public class CallbackOnPrivateMessage extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnPrivateMessage (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnPrivateNotice.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IPrivateNotice;
 
+/**
+ * Callback to all objects implementing the IPrivateNotice Interface.
+ */
 public class CallbackOnPrivateNotice extends CallbackObjectSpecific {
 	/**
 	 * Callback to all objects implementing the IPrivateNotice Interface.
@@ -35,6 +38,7 @@ public class CallbackOnPrivateNotice extends CallbackObjectSpecific {
 	 * @see IPrivateNotice
 	 * @param sMessage Notice contents
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String sMessage, String sHost) {
 		boolean bResult = false;
@@ -61,4 +65,4 @@ public class CallbackOnPrivateNotice extends CallbackObjectSpecific {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnPrivateNotice (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnQuit.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IQuit;
 
+/**
+ * Callback to all objects implementing the IQuit Interface.
+ */
 public class CallbackOnQuit extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IQuit Interface.
@@ -35,6 +38,7 @@ public class CallbackOnQuit extends CallbackObject {
 	 * @see IQuit
 	 * @param cClient Client Quitting
 	 * @param sReason Reason for quitting (may be "")
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ClientInfo cClient, String sReason) {
 		boolean bResult = false;
@@ -58,4 +62,4 @@ public class CallbackOnQuit extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnQuit (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnServerReady.java

@@ -28,12 +28,16 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IServerReady;
 
+/**
+ * Callback to all objects implementing the IServerReady Interface.
+ */
 public class CallbackOnServerReady extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IServerReady Interface.
 	 *
 	 * @see IServerReady
-	 */	
+	 * @return true if a callback was called, else false
+	 */
 	public boolean call() {
 		boolean bResult = false;
 		for (int i = 0; i < callbackInfo.size(); i++) {
@@ -56,4 +60,4 @@ public class CallbackOnServerReady extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnServerReady (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnSocketClosed.java

@@ -28,12 +28,16 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.ISocketClosed;
 
+/**
+ * Callback to all objects implementing the ISocketClosed Interface.
+ */
 public class CallbackOnSocketClosed extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the ISocketClosed Interface.
 	 *
 	 * @see ISocketClosed
-	 */	
+	 * @return true if a callback was called, else false
+	 */
 	public boolean call() {
 		boolean bResult = false;
 		for (int i = 0; i < callbackInfo.size(); i++) {
@@ -56,4 +60,4 @@ public class CallbackOnSocketClosed extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnSocketClosed (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnUnknownAction.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IUnknownAction;
 
+/**
+ * Callback to all objects implementing the IUnknownAction Interface.
+ */
 public class CallbackOnUnknownAction extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IUnknownAction Interface.
@@ -36,6 +39,7 @@ public class CallbackOnUnknownAction extends CallbackObject {
 	 * @param sMessage Action contents
 	 * @param sTarget Actual target of action
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String sMessage, String sTarget, String sHost) {
 		boolean bResult = false;
@@ -59,4 +63,4 @@ public class CallbackOnUnknownAction extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnUnknownAction (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnUnknownCTCP.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IUnknownCTCP;
 
+/**
+ * Callback to all objects implementing the IUnknownCTCP Interface.
+ */
 public class CallbackOnUnknownCTCP extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IUnknownCTCP Interface.
@@ -37,6 +40,7 @@ public class CallbackOnUnknownCTCP extends CallbackObject {
 	 * @param sMessage Additional contents
 	 * @param sTarget Actual Target of CTCP
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String sType, String sMessage, String sTarget, String sHost) {
 		boolean bResult = false;
@@ -60,4 +64,4 @@ public class CallbackOnUnknownCTCP extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnUnknownCTCP (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnUnknownCTCPReply.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IUnknownCTCPReply;
 
+/**
+ * Callback to all objects implementing the IUnknownCTCPReply Interface.
+ */
 public class CallbackOnUnknownCTCPReply extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IUnknownCTCPReply Interface.
@@ -37,6 +40,7 @@ public class CallbackOnUnknownCTCPReply extends CallbackObject {
 	 * @param sMessage Reply Contents
 	 * @param sTarget Actual Target of CTCPReply
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String sType, String sMessage, String sTarget, String sHost) {
 		boolean bResult = false;
@@ -60,4 +64,4 @@ public class CallbackOnUnknownCTCPReply extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnUnknownCTCPReply (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnUnknownMessage.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IUnknownMessage;
 
+/**
+ * Callback to all objects implementing the IUnknownMessage Interface.
+ */
 public class CallbackOnUnknownMessage extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IUnknownMessage Interface.
@@ -36,6 +39,7 @@ public class CallbackOnUnknownMessage extends CallbackObject {
 	 * @param sMessage Message contents
 	 * @param sTarget Actual target of message
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String sMessage, String sTarget, String sHost) {
 		boolean bResult = false;
@@ -59,4 +63,4 @@ public class CallbackOnUnknownMessage extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnUnknownMessage (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnUnknownNotice.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import  uk.org.ownage.dmdirc.parser.callbacks.interfaces.IUnknownNotice;
 
+/**
+ * Callback to all objects implementing the IUnknownNotice Interface.
+ */
 public class CallbackOnUnknownNotice extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IUnknownNotice Interface.
@@ -36,6 +39,7 @@ public class CallbackOnUnknownNotice extends CallbackObject {
 	 * @param sMessage Notice contents
 	 * @param sTarget Actual target of notice
 	 * @param sHost Hostname of sender (or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(String sMessage, String sTarget, String sHost) {
 		boolean bResult = false;
@@ -59,4 +63,4 @@ public class CallbackOnUnknownNotice extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnUnknownNotice (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/CallbackOnUserModeChanged.java

@@ -28,6 +28,9 @@ import uk.org.ownage.dmdirc.parser.*;
 import uk.org.ownage.dmdirc.parser.callbacks.CallbackManager;
 import uk.org.ownage.dmdirc.parser.callbacks.interfaces.IUserModeChanged;
 
+/**
+ * Callback to all objects implementing the IUserModeChanged Interface.
+ */
 public class CallbackOnUserModeChanged extends CallbackObject {
 	/**
 	 * Callback to all objects implementing the IUserModeChanged Interface.
@@ -35,6 +38,7 @@ public class CallbackOnUserModeChanged extends CallbackObject {
 	 * @see IUserModeChanged
 	 * @param cClient Client that had the mode changed (almost always us)
 	 * @param sSetby Host that set the mode (us or servername)
+	 * @return true if a callback was called, else false
 	 */
 	public boolean call(ClientInfo cClient, String sSetby) {
 		boolean bResult = false;
@@ -58,4 +62,5 @@ public class CallbackOnUserModeChanged extends CallbackObject {
 	 * @param manager CallbackManager that is in charge of this callback
 	 */
 	public CallbackOnUserModeChanged (IRCParser parser, CallbackManager manager) { super(parser, manager); }
-}
+}
+

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/ICallbackInterface.java

@@ -27,4 +27,4 @@ package uk.org.ownage.dmdirc.parser.callbacks.interfaces;
 /**
  * "SuperInterface" for all callbacks
  */
-public interface ICallbackInterface { }
+public interface ICallbackInterface { }

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelAction.java

@@ -1,3 +1,4 @@
+
 /*
  * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack
  *
@@ -48,4 +49,4 @@ public interface IChannelAction extends ICallbackInterface {
 	 * @see ProcessMessage#callChannelAction
 	 */
 	public void onChannelAction(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sMessage, String sHost );
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelCTCP.java

@@ -49,4 +49,4 @@ public interface IChannelCTCP extends ICallbackInterface {
 	 * @see ProcessMessage#callChannelCTCP
 	 */
 	public void onChannelCTCP(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sType, String sMessage, String sHost );
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelCTCPReply.java

@@ -49,4 +49,4 @@ public interface IChannelCTCPReply extends ICallbackInterface {
 	 * @see ProcessMessage#callChannelCTCPReply
 	 */
 	public void onChannelCTCPReply(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sType, String sMessage, String sHost );
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelGotNames.java

@@ -40,4 +40,4 @@ public interface IChannelGotNames extends ICallbackInterface {
 	 * @see ProcessNames#callChannelGotNames
 	 */
 	public void onChannelGotNames(IRCParser tParser, ChannelInfo cChannel);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelJoin.java

@@ -44,4 +44,4 @@ public interface IChannelJoin extends ICallbackInterface {
 	 * @see ProcessJoin#callChannelJoin
 	 */
 	public void onChannelJoin(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient );
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelKick.java

@@ -47,4 +47,4 @@ public interface IChannelKick extends ICallbackInterface {
 	 * @see ProcessKick#callChannelKick
 	 */
 	public void onChannelKick(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cKickedClient, ChannelClientInfo cKickedByClient, String sReason, String sKickedByHost);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelMessage.java

@@ -48,4 +48,4 @@ public interface IChannelMessage extends ICallbackInterface {
 	 * @see ProcessMessage#callChannelMessage
 	 */
 	public void onChannelMessage(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sMessage, String sHost );
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelModeChanged.java

@@ -48,4 +48,4 @@ public interface IChannelModeChanged extends ICallbackInterface {
 	 * @see ProcessMode#callChannelModeChanged
 	 */
 	public void onChannelModeChanged(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sHost, String sModes);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelNickChanged.java

@@ -45,4 +45,4 @@ public interface IChannelNickChanged extends ICallbackInterface {
 	 * @see ProcessNick#callChannelNickChanged
 	 */
 	 public void onChannelNickChanged(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sOldNick);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelNonUserModeChanged.java

@@ -48,3 +48,4 @@ public interface IChannelNonUserModeChanged extends ICallbackInterface {
 	 */
 	public void onChannelNonUserModeChanged(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sHost, String sModes);
 }
+

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelNotice.java

@@ -48,4 +48,4 @@ public interface IChannelNotice extends ICallbackInterface {
 	 * @see ProcessMessage#callChannelNotice
 	 */
 	public void onChannelNotice(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sMessage, String sHost );
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelPart.java

@@ -45,4 +45,4 @@ public interface IChannelPart extends ICallbackInterface {
 	 * @see ProcessPart#callChannelPart
 	 */
 	public void onChannelPart(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sReason );
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelQuit.java

@@ -45,4 +45,4 @@ public interface IChannelQuit extends ICallbackInterface {
 	 * @see ProcessQuit#callChannelQuit
 	 */
 	public void onChannelQuit(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sReason );
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelSelfJoin.java

@@ -42,4 +42,4 @@ public interface IChannelSelfJoin extends ICallbackInterface {
 	 * @see ProcessJoin#callChannelSelfJoin
 	 */
 	public void onChannelSelfJoin(IRCParser tParser, ChannelInfo cChannel);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelSingleModeChanged.java

@@ -48,3 +48,4 @@ public interface IChannelSingleModeChanged extends ICallbackInterface {
 	 */
 	public void onChannelSingleModeChanged(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChannelClient, String sHost, String sModes);
 }
+

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelTopic.java

@@ -43,4 +43,4 @@ public interface IChannelTopic extends ICallbackInterface {
 	 * @see ProcessTopic#callChannelTopic
 	 */
 	public void onChannelTopic(IRCParser tParser, ChannelInfo cChannel, boolean bIsJoinTopic);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IChannelUserModeChanged.java

@@ -47,4 +47,4 @@ public interface IChannelUserModeChanged extends ICallbackInterface {
 	 * @see ProcessMode#callChannelUserModeChanged
 	 */
 	public void onChannelUserModeChanged(IRCParser tParser, ChannelInfo cChannel, ChannelClientInfo cChangedClient, ChannelClientInfo cSetByClient, String sHost, String sMode);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IDataIn.java

@@ -38,4 +38,4 @@ public interface IDataIn extends ICallbackInterface {
 	 * @see IRCParser#callDataIn
 	 */
 	public void onDataIn(IRCParser tParser, String sData);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IDataOut.java

@@ -39,4 +39,4 @@ public interface IDataOut extends ICallbackInterface {
 	 * @see IRCParser#callDataOut
 	 */
 	public void onDataOut(IRCParser tParser, String sData, boolean bFromParser);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IDebugInfo.java

@@ -39,4 +39,4 @@ public interface IDebugInfo extends ICallbackInterface {
 	 * @see IRCParser#callDebugInfo
 	 */
 	public void onDebugInfo(IRCParser tParser, int nLevel, String sData);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IErrorInfo.java

@@ -39,4 +39,4 @@ public interface IErrorInfo extends ICallbackInterface {
 	 * @see IRCParser#callErrorInfo
 	 */
 	public void onErrorInfo(IRCParser tParser, ParserError errorInfo);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IMOTDEnd.java

@@ -39,4 +39,4 @@ public interface IMOTDEnd extends ICallbackInterface {
 		* @see ProcessMOTD#callMOTDEnd
 		*/
 	public void onMOTDEnd(IRCParser tParser, boolean noMOTD);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IMOTDLine.java

@@ -39,4 +39,4 @@ public interface IMOTDLine extends ICallbackInterface {
 	 * @see ProcessMOTD#callMOTDLine
 	 */
 	public void onMOTDLine(IRCParser tParser, String sData);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IMOTDStart.java

@@ -39,4 +39,4 @@ public interface IMOTDStart extends ICallbackInterface {
 	 * @see ProcessMOTD#callMOTDStart
 	 */
 	public void onMOTDStart(IRCParser tParser, String sData);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/INickChanged.java

@@ -1,3 +1,4 @@
+
 /*
  * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack
  *
@@ -43,4 +44,4 @@ public interface INickChanged extends ICallbackInterface {
 	 * @see ProcessNick#callNickChanged
 	 */
 	public void onNickChanged(IRCParser tParser, ClientInfo cClient, String sOldNick);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/INickInUse.java

@@ -38,4 +38,4 @@ public interface INickInUse extends ICallbackInterface {
 	 * @see ProcessNickInUse#callNickInUse
 	 */
 	public void onNickInUse(IRCParser tParser);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/INoticeAuth.java

@@ -39,4 +39,4 @@ public interface INoticeAuth extends ICallbackInterface {
 	 * @see ProcessNoticeAuth#callNoticeAuth
 	 */
 	public void onNoticeAuth(IRCParser tParser, String sData);
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IPrivateAction.java

@@ -44,4 +44,4 @@ public interface IPrivateAction extends ICallbackInterface {
 	 * @see ProcessMessage#callPrivateAction
 	 */
 	public void onPrivateAction(IRCParser tParser, String sMessage, String sHost );
-}
+}

src/uk/org/ownage/dmdirc/parser/callbacks/interfaces/IPrivateCTCP.java

@@ -45,4 +45,4 @@ public interface IPrivateCTCP extends ICallbackInterface {
 	 * @see ProcessMessage#callPrivateCTCP
 	 */
 	public void onPrivateCTCP(IRCParser tParser, String sType, String sMessage, String sHost );
-}
+}