aboutsummaryrefslogtreecommitdiffstats
path: root/yage/core
diff options
context:
space:
mode:
authorYann Herklotz <ymherklotz@gmail.com>2018-01-07 23:09:06 +0000
committerYann Herklotz <ymherklotz@gmail.com>2018-01-07 23:09:06 +0000
commit0a42123b150e06f28ae82e460e854984c2dc9648 (patch)
treea5909cde7cebe6d2d9f1a9da6f121b378846696e /yage/core
parentf066218b1fce4398588d6b139477399a15f750b7 (diff)
downloadYAGE-0a42123b150e06f28ae82e460e854984c2dc9648.tar.gz
YAGE-0a42123b150e06f28ae82e460e854984c2dc9648.zip
[Docs] Changing documentation
Diffstat (limited to 'yage/core')
-rw-r--r--yage/core/loglevel.h20
1 files changed, 18 insertions, 2 deletions
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