From 1f7cb1180421e701d978a6c661ba4d2d70f59ca3 Mon Sep 17 00:00:00 2001
From: "Tristan B. Velloza Kildaire" <deavmi@redxen.eu>
Date: Sat, 25 Mar 2023 21:39:50 +0200
Subject: [PATCH] Package (bformat)

- Documented both imports seperately
---
 source/bformat/package.d | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/source/bformat/package.d b/source/bformat/package.d
index 90a864a..7629bd7 100644
--- a/source/bformat/package.d
+++ b/source/bformat/package.d
@@ -1,3 +1,15 @@
 module bformat;
 
-public import bformat.sockets : sendMessage, receiveMessage;
\ No newline at end of file
+/**
+ * Encodes the provided message into the bformat format
+ * and sends it over the provided socket
+ */
+public import bformat.sockets : sendMessage;
+
+/**
+ * Receives a message from the provided socket
+ * by decoding the streamed bytes into bformat
+ * and finally placing the resulting payload in
+ * the provided array
+ */
+public import bformat.sockets : receiveMessage;
\ No newline at end of file