From 6688d6dfdf795c42580acb83612be0dc83c5c599 Mon Sep 17 00:00:00 2001
From: "Tristan B. Velloza Kildaire" <deavmi@redxen.eu>
Date: Sat, 18 Mar 2023 11:29:41 +0200
Subject: [PATCH] Config

- Documented package module

Client

- Documented package module

Protocol

- Documented package module

Birchwood

- Documented package module
---
 source/birchwood/client/package.d   | 12 +++++++++++-
 source/birchwood/config/package.d   |  6 ++++++
 source/birchwood/package.d          | 14 ++++++++++++++
 source/birchwood/protocol/package.d | 14 +++++++++++++-
 4 files changed, 44 insertions(+), 2 deletions(-)

diff --git a/source/birchwood/client/package.d b/source/birchwood/client/package.d
index 0745f2b..7f0d958 100644
--- a/source/birchwood/client/package.d
+++ b/source/birchwood/client/package.d
@@ -1,4 +1,14 @@
+/** 
+ * IRC client and runtime related
+ */
 module birchwood.client;
 
+/**
+ * IRC client
+ */
 public import birchwood.client.client;
-public import birchwood.client.exceptions : BirchwoodException;
\ No newline at end of file
+
+/**
+ * Error handling
+ */
+public import birchwood.client.exceptions;
\ No newline at end of file
diff --git a/source/birchwood/config/package.d b/source/birchwood/config/package.d
index 808ee27..1bb8dfd 100644
--- a/source/birchwood/config/package.d
+++ b/source/birchwood/config/package.d
@@ -1,3 +1,9 @@
+/**
+ * Configuration system
+ */
 module birchwood.config;
 
+/**
+ * Connection information
+ */
 public import birchwood.config.conninfo : ConnectionInfo;
\ No newline at end of file
diff --git a/source/birchwood/package.d b/source/birchwood/package.d
index d9018f1..4925ed1 100644
--- a/source/birchwood/package.d
+++ b/source/birchwood/package.d
@@ -1,5 +1,19 @@
+/**
+ * A sane IRC framework for the D language
+ */
 module birchwood;
 
+/**
+ * Client
+ */
 public import birchwood.client;
+
+/**
+ * Configuration
+ */
 public import birchwood.config;
+
+/**
+ * Encoding and decoding
+ */
 public import birchwood.protocol;
\ No newline at end of file
diff --git a/source/birchwood/protocol/package.d b/source/birchwood/protocol/package.d
index 733ce7a..64e0468 100644
--- a/source/birchwood/protocol/package.d
+++ b/source/birchwood/protocol/package.d
@@ -1,7 +1,19 @@
+/**
+ * IRC protocol decoding and encoding
+ */
 module birchwood.protocol;
 
+/**
+ * Message type and parsing
+ */
 public import birchwood.protocol.messages : Message;
+
+/**
+ * Numeric response codes
+ */
 public import birchwood.protocol.constants : ReplyType;
 
-// TODO: Look how to neaten up (if any)
+/**
+ * Message formatting utilities
+ */
 public import birchwood.protocol.formatting;
\ No newline at end of file