Basic

- Documented `shout()`
tbklang · Dec 23, 2023 · d7d25c2 · d7d25c2
1 parent 13a7b52
commit d7d25c2
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/source/tlang/compiler/lexer/kinds/basic.d b/source/tlang/compiler/lexer/kinds/basic.d
@@ -684,6 +684,15 @@ public final class BasicLexer : LexerInterface
     }
 }
 
+/** 
+ * Does a print out of some text just to show you
+ * where you are from within the caller
+ *
+ * Params:
+ *   __LINE__ = line number (auto-filled)
+ *   __MODULE__ = module name (auto-filled)
+ *   __FUNCTION__ = function name (auto-filled)
+ */
 private void shout(int i = __LINE__, string mod = __MODULE__, string func = __FUNCTION__)
 {
     gprintln("Unittest at "~to!(string)(i)~" in "~func~" (within module "~mod~")");