9.4. Logging Messages¶
The logging of messages is handled by three dedicated macros, one for each available verbosity level (see Verbosity Level):
logInfo
: Logs messages withLog::Kind::Info
verbosity.logWarning
: Logs messages withLog::Kind::Warning
verbosity.logError
: Logs messages withLog::Kind::Error
verbosity.
Said macros take exactly two arguments, a category and a message, and produce a log entry showing the message itself plus some meta information depending on the module’s configuration (see Log Entry Specification and Log Entry).
logInfo(DOCUMENTATION_CATEGORY, "This is an info message");
logWarning(DOCUMENTATION_CATEGORY, "This is an warning message");
logError(DOCUMENTATION_CATEGORY, "This is an error message");
Warning
Note that each message level is deactivated when CMake options LOG_NO_INFO
, LOG_NO_WARNING
or
LOG_NO_ERROR
are set to ON
respectively.
For more information about how to enable and disable each individual logging macro, please refer to
Disable Logging Module.