.. include:: ../../defs.hrst

Logging
#######

How to log messages
===================

There are several logging methods available in the `logging` module. The methods are designed to only cause
call overhead when obscura is built with the `DEBUG` flag. The methods are:

.. doxygenfunction:: obscura::logInfo
.. doxygenfunction:: obscura::logWarn
.. doxygenfunction:: obscura::logError
.. doxygenfunction:: obscura::logDebug
.. doxygenfunction:: obscura::logTrace

Internally, a different set of methods is used to log messages. These methods are:

.. doxygenfunction:: obscura::logCoreInfo
.. doxygenfunction:: obscura::logCoreWarn
.. doxygenfunction:: obscura::logCoreError
.. doxygenfunction:: obscura::logCoreDebug
.. doxygenfunction:: obscura::logCoreTrace

Example
=======

.. literalinclude:: ../../../../examples/how_to_log.cxx
    :language: c++