Utils/Logger: Documentation

[senf.git] / Utils / Logger / Log.hh

diff --git a/Utils/Logger/Log.hh b/Utils/Logger/Log.hh
index 81b7703..028d14e 100644 (file)
--- a/Utils/Logger/Log.hh
+++ b/Utils/Logger/Log.hh
@@ -49,15 +49,16 @@
     SENF_LOG( (senf::log::Debug)(senf::log::NOTICE)(FroblizerArea)("The log message") );
     \endcode
 
-    For each log message, the following information is needed:
+    The argument is comprised of a sequence of parameters and the log message itself. The parameters
+    are
     \li The <em>log stream</em>,
     \li the <em>log area</em>,
     \li the <em>log level</em>,
-    \li and the log message itself
     
-    These parameters may be specified <i>in arbitrary order</i> and even multiple times in the
-    parameter sequence. If some argument type occurs multiple times, the last occurrence wins. If
-    any one of the parameters is not specified, it's current default value will be used.
+    These parameters are optional and may be specified <i>in arbitrary order</i> (with the log
+    message always being the last sequence element) and even multiple times in the parameter
+    sequence. If some argument type occurs multiple times, the last occurrence wins. If any one of
+    the parameters is not specified, it's current default value will be used.
 
     This current default value is set using \ref SENF_LOG_DEFAULT_STREAM, \ref SENF_LOG_DEFAULT_AREA
     and \ref SENF_LOG_DEFAULT_LEVEL respectively. These macros set the default stream, area and/or
@@ -65,10 +66,9 @@
     be \c senf::log::Debug (\e stream), senf::log::DefaultArea (\e area), and senf::log::NONE (\e
     level).
 
-    There is one special log level, senf::log::NONE. If the log level is set to this value, the log
-    level will be set from the stream provided default value.
+    The log level senf::log::NONE is special. If the log level is set to this value, the log level
+    will be set from the stream provided default value.
     
-
     All these parameters must be <em>compile time constants</em> (they are all types, so it's
     difficult form them to be something else).
  */
@@ -128,8 +128,8 @@
     \hideinitializer
  */
 #define SENF_LOG_BLOCK_TPL(args)                                                                  \
-    SENF_LOG_BLOCK_( SENF_LOG_MERGE_PARAMETERS_TPL(BOOST_PP_SEQ_POP_BACK(args)),                  \
-                     BOOST_PP_SEQ_ELEM(BOOST_PP_DEC(BOOST_PP_SEQ_SIZE(args)),args))
+    SENF_LOG_BLOCK_TPL_( SENF_LOG_MERGE_PARAMETERS_TPL(BOOST_PP_SEQ_POP_BACK(args)),              \
+                         BOOST_PP_SEQ_ELEM(BOOST_PP_DEC(BOOST_PP_SEQ_SIZE(args)),args))
 
 ///\}
 ///\}