From 0a42123b150e06f28ae82e460e854984c2dc9648 Mon Sep 17 00:00:00 2001 From: Yann Herklotz Date: Sun, 7 Jan 2018 23:09:06 +0000 Subject: [Docs] Changing documentation --- yage/core/loglevel.h | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) (limited to 'yage') diff --git a/yage/core/loglevel.h b/yage/core/loglevel.h index 78af24af..2247375d 100644 --- a/yage/core/loglevel.h +++ b/yage/core/loglevel.h @@ -9,16 +9,32 @@ #ifndef YAGE_CORE_LOGLEVEL_H #define YAGE_CORE_LOGLEVEL_H -namespace yage { +namespace yage +{ +/** + * Different log levels that can be assigned to each message sent to the Logger. + * The logger then outputs the message if it is above the minimum log level, or + * does not process it. + */ enum class LogLevel { + /// Lowest log level. This is used by the game engine to output debugging + /// information but is turned off in the logger by default. DEBUG, + + /// Information message. INFO, + + /// Warning message. WARNING, + + /// Error message. ERROR, + + /// Fatal message that should be output when the game + /// crashes. FATAL, }; - } #endif -- cgit