From 672b8fee645c835d1a930432dcd6321996abc745 Mon Sep 17 00:00:00 2001 From: "Tristan B. Velloza Kildaire" Date: Wed, 15 Mar 2023 20:23:30 +0200 Subject: [PATCH] Client - Added some TODOs for comments --- source/birchwood/client/client.d | 34 +++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/source/birchwood/client/client.d b/source/birchwood/client/client.d index 248145f..ffdecf1 100644 --- a/source/birchwood/client/client.d +++ b/source/birchwood/client/client.d @@ -80,23 +80,55 @@ public class Client : Thread /** * User overridable handler functions below */ + + // TODO: comment + /** + * + * Params: + * fullMessage = + * channel = + * msgBody = + */ public void onChannelMessage(Message fullMessage, string channel, string msgBody) { /* Default implementation */ logger.log("Channel("~channel~"): "~msgBody); } + + // TODO: comment + /** + * + * Params: + * fullMessage = + * nickname = + * msgBody = + */ public void onDirectMessage(Message fullMessage, string nickname, string msgBody) { /* Default implementation */ logger.log("DirectMessage("~nickname~"): "~msgBody); } + + // TODO: comment + /** + * + * Params: + * message = + */ public void onGenericCommand(Message message) { /* Default implementation */ logger.log("Generic("~message.getCommand()~", "~message.getFrom()~"): "~message.getParams()); } + + + // TODO: Hook certain ones default style with an implemenation + // ... for things that the client can learn from public void onCommandReply(Message commandReply) { + // TODO: Add numeric response check here for CERTAIN ones which add to client + // ... state + /* Default implementation */ logger.log("Response("~to!(string)(commandReply.getReplyType())~", "~commandReply.getFrom()~"): "~commandReply.toString()); } @@ -526,7 +558,7 @@ public class Client : Thread { // TODO: Add numeric response check here for CERTAIN ones which add to client // ... state - + /* Call the command reply handler */ onCommandReply(ircMessage); }