From 919e4583005e5b225dee4203b74ad5cf113b35c6 Mon Sep 17 00:00:00 2001
From: "Tristan B. Velloza Kildaire" <deavmi@redxen.eu>
Date: Sat, 25 Mar 2023 14:20:51 +0200
Subject: [PATCH] Client

- Added documentation to `doAuth(string)` and `user(string.s tring, string, string)`
---
 source/birchwood/client/client.d | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/source/birchwood/client/client.d b/source/birchwood/client/client.d
index cd784dc..042a055 100644
--- a/source/birchwood/client/client.d
+++ b/source/birchwood/client/client.d
@@ -829,6 +829,12 @@ public class Client : Thread
         }
     }
 
+    /** 
+     * Performs the /NICK and /USER handshake
+     *
+     * Params:
+     *   servername = the servername to use (default: bogus.net)
+     */
     private void doAuth(string servername = "bogus.net")
     {
         Thread.sleep(dur!("seconds")(2));
@@ -840,6 +846,15 @@ public class Client : Thread
         user(connInfo.username, connInfo.username, servername, connInfo.realname);
     }
 
+    /** 
+     * Performs user identification
+     *
+     * Params:
+     *   username = the username to identify with
+     *   hostname = the hostname to use
+     *   servername = the servername to use
+     *   realname = your realname
+     */
     public void user(string username, string hostname, string servername, string realname)
     {
         // TODO: Implement me properly with all required checks