From 1da039dcb2c85b2b9d84bea54f1a9dc6fe020fbd Mon Sep 17 00:00:00 2001
From: "Tristan B. Velloza Kildaire" <deavmi@redxen.eu>
Date: Sat, 25 Mar 2023 14:26:32 +0200
Subject: [PATCH] ConnectionInfo

- Added documentation to `T getDB(T)(string)` and `updateDB(string, string)`
---
 source/birchwood/config/conninfo.d | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/source/birchwood/config/conninfo.d b/source/birchwood/config/conninfo.d
index 4c780c9..3f24fc4 100644
--- a/source/birchwood/config/conninfo.d
+++ b/source/birchwood/config/conninfo.d
@@ -135,11 +135,27 @@ public shared struct ConnectionInfo
         this.fakeLag = fakeLag;
     }
 
+    /** 
+     * Update a value in the key-value pair database
+     *
+     * Params:
+     *   key = the key to set
+     *   value = the value to set to
+     */
     public void updateDB(string key, string value)
     {
         db[key] = value;
     }
 
+    /** 
+     * Retrieve a value from the key-value pair database
+     *
+     * Params:
+     *   key = the key to lookup
+     * Returns: the value as type T, if not able to convert then T.init
+     * Throws:
+     *   BirchwoodException if the key is not found
+     */
     public T getDB(T)(string key)
     {
         import std.stdio;