diff options
author | Yann Herklotz <ymherklotz@gmail.com> | 2018-01-06 10:53:25 +0000 |
---|---|---|
committer | Yann Herklotz <ymherklotz@gmail.com> | 2018-01-06 10:56:56 +0000 |
commit | 6b962c6c1409581923dfd04fcad3a0be90f71bbf (patch) | |
tree | 9e9b67f93dfe117775e3a6078c4ae9d6fa09842b /docs | |
parent | db6480dccd9a3dbf4100a824930a36251f4e743c (diff) | |
download | YAGE-6b962c6c1409581923dfd04fcad3a0be90f71bbf.tar.gz YAGE-6b962c6c1409581923dfd04fcad3a0be90f71bbf.zip |
[Docs] Adding documentaion to camera
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Doxyfile.in | 4 | ||||
-rw-r--r-- | docs/logger.dox | 43 |
2 files changed, 45 insertions, 2 deletions
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index ebb324e2..9feb54a8 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -107,7 +107,7 @@ BRIEF_MEMBER_DESC = YES # brief descriptions will be completely suppressed. # The default value is: YES. -REPEAT_BRIEF = NO +REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found @@ -441,7 +441,7 @@ EXTRACT_ALL = YES # be included in the documentation. # The default value is: NO. -EXTRACT_PRIVATE = YES +EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. diff --git a/docs/logger.dox b/docs/logger.dox new file mode 100644 index 00000000..57f3a052 --- /dev/null +++ b/docs/logger.dox @@ -0,0 +1,43 @@ +/** @class yage::Logger + +## Logger + +Aynchronous logging is built into the YAGE library, which can be used to log events in the game +and also debug the game by using the debug output that the game engine produces. This can help +if for example, a texture is being loaded. + +### Log levels + +The logger has five different levels that can be assigned to a message. These are, from lowest to +highest severity, `LogLevel::DEBUG`, `LogLevel::INFO`, `LogLevel::WARNING`, `LogLevel::ERROR` +and `LogLevel::FATAL`. Messages that the developer then wants to write to the logs can take any +of these severities and the developer can then decide what the minimum severity is that the logger +should log. By default, the logger will log anything that is above `LogLevel::INFO`. + +### Using the Logger in your Game + +There are a few preprocessor definitions to make the use of the logger as simple as possible. +First of all, there is a definition to get the instance of the current global logger, which +can then be used to set a different minimum display level. This definition is `yLogger`, and an +example of how to use it to change the default output level can be seen below + +``` c++ +yLogger.setLevel(yage::LogLevel::ERROR); +``` + +The above code changes the global logger so that it will only output things that are an error or +fatal and make the engine crash. + + +Other preprocessor definitions are `yLogDebug`, `yLogInfo`, `yLogWarning`, `yLogError` and +`yLogFatal`. These return an object that is similar to a buffer, but belongs to the main +global logger `yLogger`. These are the definitions that should be used to print somehting +to the main logger. For example + +``` c++ +yLogWarning << "This is a warning"; +``` + +will print the message "This is a warning" with the severity of `LogLevel::WARNING`. + +*/
\ No newline at end of file |