Documentation

- Mention the styles available in the `README.md`
- Added comments to enum members
- Added documentation to alias
This commit is contained in:
Tristan B. Velloza Kildaire 2023-03-03 11:38:10 +02:00
parent a4e17acbd2
commit 69f92a7b2e
3 changed files with 19 additions and 3 deletions

View File

@ -29,7 +29,9 @@ This should output something like the following:
![](example.png) ![](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).

View File

@ -189,7 +189,8 @@ public class GoggaLogger : Logger
/** /**
* Logs using the default context an arbitrary amount of arguments * 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: * Params:
* segments = the arbitrary argumnets (alias sequence) * 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_; public alias dbg = debug_;
/** /**

View File

@ -13,8 +13,19 @@ import std.conv : to;
*/ */
public enum GoggaMode public enum GoggaMode
{ {
/**
* TwoKTwenty3 is: `[<file>] (<module>:<lineNumber>) <message>`
*/
TwoKTwenty3, TwoKTwenty3,
/**
* Simple mode is just: `[<LEVEL>] <message>`
*/
SIMPLE, SIMPLE,
/**
* Rustacean mode is: `[<LEVEL>] (<filePath>/<functionName>:<lineNumber>) <message>`
*/
RUSTACEAN RUSTACEAN
} }