Docs Update

This commit is contained in:
Robert Jelic
2025-02-18 09:46:32 +01:00
parent d821bfd6a6
commit 8b6eaccd18
33 changed files with 1477 additions and 418 deletions

View File

@@ -1,3 +1,4 @@
--- Logger module for Basalt. Logs messages to the console and optionally to a file.
--- @class Log
--- @field _logs table The complete log history
--- @field _enabled boolean If the logger is enabled
@@ -87,10 +88,9 @@ end
--- Sends a debug message to the logger.
--- @shortDescription Sends a debug message
--- @vararg string The message to log
--- @usage Log.debug("This is a debug message")
function Log.debug(...)
log(Log.LEVEL.DEBUG, ...)
end
function Log.debug(...) log(Log.LEVEL.DEBUG, ...) end
--- Sends an info message to the logger.
--- @shortDescription Sends an info message
@@ -110,6 +110,4 @@ function Log.warn(...) log(Log.LEVEL.WARN, ...) end
--- @usage Log.error("This is an error message")
function Log.error(...) log(Log.LEVEL.ERROR, ...) end
Log.info("Logger initialized")
return Log