From 9cc40938ee2cfabd7f02aba102a50ebd82d4e163 Mon Sep 17 00:00:00 2001
From: "Tristan B. Velloza Kildaire" <deavmi@redxen.eu>
Date: Thu, 16 Mar 2023 08:38:47 +0200
Subject: [PATCH] Receiver

- Added documentation for `rq`

Sender

- Added documentation for `sq`
---
 source/birchwood/client/receiver.d | 7 +++++++
 source/birchwood/client/sender.d   | 7 +++++++
 2 files changed, 14 insertions(+)

diff --git a/source/birchwood/client/receiver.d b/source/birchwood/client/receiver.d
index 93be2e8..5957b29 100644
--- a/source/birchwood/client/receiver.d
+++ b/source/birchwood/client/receiver.d
@@ -53,6 +53,13 @@ public final class ReceiverThread : Thread
     }
 
     // TODO: Rename to `receiveQ`
+    /** 
+     * Enqueues the raw message into the receieve queue
+     * for eventual processing
+     *
+     * Params:
+     *   encodedMessage = the message to enqueue
+     */
     public void rq(ubyte[] encodedMessage)
     {
         /* Lock queue */
diff --git a/source/birchwood/client/sender.d b/source/birchwood/client/sender.d
index 8f22468..3e70f90 100644
--- a/source/birchwood/client/sender.d
+++ b/source/birchwood/client/sender.d
@@ -48,6 +48,13 @@ public final class SenderThread : Thread
     }
 
     // TODO: Rename to `sendQ`
+    /** 
+     * Enqueues the raw message into the send queue
+     * for eventual sending
+     *
+     * Params:
+     *   encodedMessage = the message to enqueue
+     */
     public void sq(ubyte[] encodedMessage)
     {
         /* Lock queue */