Commit ea414404 authored by Julien Michel's avatar Julien Michel

DOC: Add proper documentation on the behavior of OTB_LOGGER_LEVEL macro

parent d00cd6c7
......@@ -84,7 +84,25 @@ public:
*/
static RAMValueType GetMaxRAMHint();
/**
* Logger level controls the level of logging that OTB will output.
*
* This is used to set-up the otb::Logger class.
*
* If OTB_LOGGER_LEVEL environment variable is set to one of DEBUG,
* INFO, WARNING, CRITICAL or FATAL, the logger level will be
* set accordingly.
*
* Priority is DEBUG < INFO < WARNING < CRITICAL < FATAL.
*
* Only messages with a higher priority than the logger level will
* be displayed.
*
* By default (if OTB_LOGGER_LEVEL is not set or can not be
* decoded), level is DEBUG in Debug or RelWithDebInfo builds, and
* WARNING otherwise.
*
*/
static itk::LoggerBase::PriorityLevelType GetLoggerLevel();
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment