From 6be4be3534ca29da07cce42e44783c308b68e024 Mon Sep 17 00:00:00 2001
From: "Tristan B. Velloza Kildaire" <deavmi@redxen.eu>
Date: Tue, 9 Apr 2024 19:30:56 +0200
Subject: [PATCH] Basics

- More docs
---
 source/dlog/basic.d | 52 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 51 insertions(+), 1 deletion(-)

diff --git a/source/dlog/basic.d b/source/dlog/basic.d
index 32d6ecc..9fa4dda 100644
--- a/source/dlog/basic.d
+++ b/source/dlog/basic.d
@@ -99,15 +99,39 @@ public class BasicMessage : Message
     }
 }
 
+/** 
+ * A file-based handler which
+ * writes `BasicMessage`(s)
+ * to a provided file
+ */
 public class FileHandler : Handler
 {
-    
+    /** 
+     * File to write to
+     */
     private File file;
+
+    /** 
+     * Constrtucts a new
+     * `FileHandler` with
+     * the given file
+     *
+     * Params:
+     *   file = the file
+     */
     this(File file)
     {
         this.file = file;
     }
 
+    /** 
+     * Handles the message, does a
+     * no-op if the message is
+     * not a kind-of `BasicMessage`
+     *
+     * Params:
+     *   message = the message
+     */
     public void handle(Message message)
     {
         // Only handle BasicMessage(s)
@@ -145,15 +169,41 @@ public enum Level
     DEBUG
 }
 
+/** 
+ * A level-based filter which
+ * has a predicate which operates
+ * on the value of a pointed-to
+ * `Level` variable
+ */
 private class LevelFilter : Filter
 {
+    /** 
+     * Address of the level var
+     */
     private Level* level;
 
+    /** 
+     * Constructs a new `LevelFilter`
+     * with the given `Level*`
+     *
+     * Params:
+     *   level = the level address
+     */
     this(Level* level)
     {
         this.level = level;
     }
 
+    /** 
+     * Filters the given message according
+     * to the current level. This will no-op
+     * and always return `true` if the message
+     * is not a kind-of `BasicMessage`
+     *
+     * Params:
+     *   message = the message
+     * Returns: the verdict
+     */
     public bool filter(Message message)
     {
         // Only handle BasicMessage(s)