From 9e68d941200d4e97134809f35b147b3720da8362 Mon Sep 17 00:00:00 2001 From: "Tristan B. Velloza Kildaire" Date: Sat, 18 Mar 2023 11:09:42 +0200 Subject: [PATCH] Sender - Added documentation to the `SenderThread` Receiver - Added documentation to the `ReceiveThread` --- source/birchwood/client/receiver.d | 8 ++++++++ source/birchwood/client/sender.d | 6 ++++++ 2 files changed, 14 insertions(+) diff --git a/source/birchwood/client/receiver.d b/source/birchwood/client/receiver.d index 87e92b2..3b964ab 100644 --- a/source/birchwood/client/receiver.d +++ b/source/birchwood/client/receiver.d @@ -1,3 +1,6 @@ +/** + * Receive queue management + */ module birchwood.client.receiver; import core.thread : Thread, dur; @@ -17,6 +20,11 @@ import std.string : indexOf; import birchwood.client.events : PongEvent, IRCEvent; import std.string : cmp; +/** + * Manages the receive queue and performs + * message parsing and event triggering + * based on said messages + */ public final class ReceiverThread : Thread { /** diff --git a/source/birchwood/client/sender.d b/source/birchwood/client/sender.d index 124526e..5d7fbc0 100644 --- a/source/birchwood/client/sender.d +++ b/source/birchwood/client/sender.d @@ -1,3 +1,6 @@ +/** + * Send queue management + */ module birchwood.client.sender; import core.thread : Thread, dur; @@ -11,6 +14,9 @@ import libsnooze; import birchwood.client; +/** + * Manages the send queue + */ public final class SenderThread : Thread { /**