From d982205b1b4c4c2d791ca29936249cbcd5c1d919 Mon Sep 17 00:00:00 2001
From: "Tristan B. Velloza Kildaire" <deavmi@redxen.eu>
Date: Fri, 17 Mar 2023 09:20:54 +0200
Subject: [PATCH] Messages

- Documented `getKVPairs()`, `getTrailing()` and `getPairs()`
---
 source/birchwood/protocol/messages.d | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/source/birchwood/protocol/messages.d b/source/birchwood/protocol/messages.d
index 0f405de..1e29dc1 100644
--- a/source/birchwood/protocol/messages.d
+++ b/source/birchwood/protocol/messages.d
@@ -279,17 +279,35 @@ public final class Message
         return params;
     }
 
-
+    /** 
+     * Retrieves the trailing text in the paramaters
+     * (if any)
+     *
+     * Returns: the trailing text
+     */
     public string getTrailing()
     {
         return ppTrailing;
     }
 
+    /** 
+     * Returns the parameters excluding the trailing text
+     * which are seperated by spaces but only those
+     * which are key-value pairs
+     *
+     * Returns: the key-value pair parameters
+     */
     public string[string] getKVPairs()
     {
         return ppKVPairs;
     }
 
+    /** 
+     * Returns the parameters excluding the trailing text
+     * which are seperated by spaces
+     *
+     * Returns: the parameters
+     */
     public string[] getPairs()
     {
         return ppPairs;