From 69f92a7b2e27ada0335f929e96c575cd064cc6d6 Mon Sep 17 00:00:00 2001
From: "Tristan B. Velloza Kildaire" <deavmi@redxen.eu>
Date: Fri, 3 Mar 2023 11:38:10 +0200
Subject: [PATCH] Documentation

- Mention the styles available in the `README.md`
- Added comments to enum members
- Added documentation to alias
---
 README.md                |  4 +++-
 source/gogga/core.d      |  7 +++++--
 source/gogga/transform.d | 11 +++++++++++
 3 files changed, 19 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 64e7874..167fc09 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,9 @@ This should output something like the following:
 
 ![](example.png)
 
+Various [styles](https://gogga.dpldocs.info/v2.1.14/gogga.transform.GoggaMode.html) are supported which can be set using `mode(GoggaMode)`.
+
 ---
 
-Or you can also [View the full API](https://gogga.dpldocs.info/v2.1.13/index.html).
+Or you can also [View the full API](https://gogga.dpldocs.info/v2.1.14/index.html).
 
diff --git a/source/gogga/core.d b/source/gogga/core.d
index c42795b..56332ea 100644
--- a/source/gogga/core.d
+++ b/source/gogga/core.d
@@ -189,7 +189,8 @@ public class GoggaLogger : Logger
 
 	/** 
 	 * Logs using the default context an arbitrary amount of arguments
-	 * specifically setting the context's level to DEBUG
+	 * specifically setting the context's level to DEBUG and will
+	 * only print if debugging is enabled
 	 *
 	 * Params:
 	 *   segments = the arbitrary argumnets (alias sequence)
@@ -234,7 +235,9 @@ public class GoggaLogger : Logger
 		}
 	}
 
-	/* You can also call using `dbg` */
+	/** 
+	 * Alias for debug_
+	 */
 	public alias dbg = debug_;
 
 	/** 
diff --git a/source/gogga/transform.d b/source/gogga/transform.d
index cc20f6c..239d1c2 100644
--- a/source/gogga/transform.d
+++ b/source/gogga/transform.d
@@ -13,8 +13,19 @@ import std.conv : to;
  */
 public enum GoggaMode
 {
+    /** 
+     * TwoKTwenty3 is: `[<file>] (<module>:<lineNumber>) <message>`
+     */
     TwoKTwenty3,
+
+    /** 
+     * Simple mode is just: `[<LEVEL>] <message>`
+     */
     SIMPLE,
+
+    /** 
+     * Rustacean mode is: `[<LEVEL>] (<filePath>/<functionName>:<lineNumber>) <message>`
+     */
     RUSTACEAN
 }