From 7eff8302d82f891e7bbe079c4eb210a06caba4d9 Mon Sep 17 00:00:00 2001
From: Julien Michel <julien.michel@cnes.fr>
Date: Thu, 22 Feb 2018 15:28:27 +0100
Subject: [PATCH] DOC: Add proper documentation on the behavior of
OTB_LOGGER_LEVEL macro
---
.../Common/include/otbConfigurationManager.h | 20 ++++++++++++++++++-
1 file changed, 19 insertions(+), 1 deletion(-)
diff --git a/Modules/Core/Common/include/otbConfigurationManager.h b/Modules/Core/Common/include/otbConfigurationManager.h
index 4ac1dcc372..7b32b3dc72 100644
--- a/Modules/Core/Common/include/otbConfigurationManager.h
+++ b/Modules/Core/Common/include/otbConfigurationManager.h
@@ -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();
--
GitLab