Config

- Documented package module

Client

- Documented package module

Protocol

- Documented package module

Birchwood

- Documented package module

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;
+
+/**
+ * Error handling
+ */
+public import birchwood.client.exceptions;

source/birchwood/config/package.d

@@ -1,3 +1,9 @@
+/**
+ * Configuration system
+ */
 module birchwood.config;
 
+/**
+ * Connection information
+ */
 public import birchwood.config.conninfo : ConnectionInfo;

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;

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;