Packets: Fix VariantParser invalid parser access bug
[senf.git] / Utils / Logger / Levels.hh
index bb6ce50..e53af86 100644 (file)
@@ -23,8 +23,8 @@
 /** \file
     \brief Levels public header */
 
-#ifndef HH_Levels_
-#define HH_Levels_ 1
+#ifndef HH_SENF_Utils_Logger_Levels_
+#define HH_SENF_Utils_Logger_Levels_ 1
 
 // Custom includes
 
@@ -37,11 +37,12 @@ namespace log {
 
     /** \defgroup loglevels Log levels
         
-        These are the valid log levels with some additional special values:
+        These are the valid %log levels with some additional special values:
 
-        <dl><dt>VERBOSE</dt><dd>Really verbose log messages. Messages at this level are used for
+        <dl><dt>VERBOSE</dt><dd>Really verbose %log messages. Messages at this level are used for
         internal debugging. They should be enabled only selectively within the areas currently under
-        inspection.</dd>
+        inspection. The default %log stream senf::log::Debug has these messages <em>disabled</em> at
+        compile time by default. To enable them, see \ref config.</dd>
 
         <dt>NOTICE</dt><dd>Arbitrary unimportant notice. Message which normally should be disabled
         but might be informative to better understand the programs operation.</dd>
@@ -57,45 +58,44 @@ namespace log {
         <dt>FATAL</dt><dd>Error condition which does terminate program execution or enforces a
         restart or some kind of re-initialization with loss of state and context.</dd></dl>
 
-        There are also some special values which <em>must not be used as a log level</em>:
+        There are also some special values which <em>must not be used as a %log level</em>:
         
-        <dl><dt>DISABLED</dt><dd>Disable all log messages.</dd> 
+        <dl><dt>DISABLED</dt><dd>Disable all %log messages.</dd> 
 
-        <dt>NONE</dt><dd>Special value which signifies inheritance of the default log
+        <dt>NONE</dt><dd>Special value which signifies inheritance of the default %log
         level.</dd></dl>
 
-        Log levels are classes, not numbers. Each log level class has a \c value member which gives
+        Log levels are classes, not numbers. Each %log level class has a \c value member which gives
         that levels numeric priority. The larger the number, the more important the message is.
 
-        \implementation The log levels need to be classes since areas and streams are classes: Since
-            log arguments (stream, area and level) may appear in any order and number, it is much
+        \implementation The %log levels need to be classes since areas and streams are classes: Since
+            %log arguments (stream, area and level) may appear in any order and number, it is much
             simpler to parse them if they are all of the same type.
      */
 
-    ///\ingroup loglevels
     ///\{
     
-    /** \brief Log level VERBOSE
+    /** \brief Log level %VERBOSE
         \see loglevels */
     struct VERBOSE   : public detail::LevelBase { static unsigned const value = 1; };
 
-    /** \brief Log level NOTICE
+    /** \brief Log level %NOTICE
         \see loglevels */
     struct NOTICE    : public detail::LevelBase { static unsigned const value = 2; };
 
-    /** \brief Log level MESSAGE
+    /** \brief Log level %MESSAGE
         \see loglevels */
     struct MESSAGE   : public detail::LevelBase { static unsigned const value = 3; };
 
-    /** \brief Log level IMPORTANT
+    /** \brief Log level %IMPORTANT
         \see loglevels */
     struct IMPORTANT : public detail::LevelBase { static unsigned const value = 4; };
 
-    /** \brief Log level CRITICAL
+    /** \brief Log level %CRITICAL
         \see loglevels */
     struct CRITICAL  : public detail::LevelBase { static unsigned const value = 5; };
 
-    /** \brief Log level FATAL
+    /** \brief Log level %FATAL
         \see loglevels */
     struct FATAL     : public detail::LevelBase { static unsigned const value = 6; };
 
@@ -103,7 +103,7 @@ namespace log {
         \see loglevels */
     struct DISABLED  : public detail::LevelBase { static unsigned const value = 7; };
 
-    /** \brief Inherit log level
+    /** \brief Inherit %log level
         \see loglevels */
     struct NONE      : public detail::LevelBase { static unsigned const value = 0; };