Packets: Fix VariantParser invalid parser access bug

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

diff --git a/Utils/Logger/SyslogTarget.hh b/Utils/Logger/SyslogTarget.hh
index 70cf4e3..786b58c 100644 (file)
--- a/Utils/Logger/SyslogTarget.hh
+++ b/Utils/Logger/SyslogTarget.hh
@@ -23,8 +23,8 @@
 /** \file
     \brief SyslogTarget public header */
 
-#ifndef HH_SyslogTarget_
-#define HH_SyslogTarget_ 1
+#ifndef HH_SENF_Utils_Logger_SyslogTarget_
+#define HH_SENF_Utils_Logger_SyslogTarget_ 1
 
 // Custom includes
 #include <syslog.h>
@@ -40,6 +40,13 @@ namespace log {
 
         The SyslogTarget will send all log messages to the syslog at the given facility.
 
+        \code
+        senf::log::SyslogTarget syslog;
+
+        // Route all messages to the syslog
+        syslog.route();
+        \endcode
+
         Valid facility values (taken from <tt>man 3 syslog</tt>):
         \par "" 
            <tt>LOG_AUTHPRIV</tt>, <tt>LOG_CRON</tt>, <tt>LOG_DAEMON</tt>, <tt>LOG_FTP</tt>,
@@ -50,6 +57,17 @@ namespace log {
 
         The default facility is <tt>LOG_USER</tt>.
 
+        The SENF log levels are mapped to syslog levels in the following way:
+
+        <table class="senf fixedcolumn">
+        <tr><td>senf::log::VERBOSE</td>   <td>\c LOG_DEBUG</td></tr>
+        <tr><td>senf::log::NOTICE</td>    <td>\c LOG_INFO</td></tr>
+        <tr><td>senf::log::MESSAGE</td>   <td>\c LOG_NOTICE</td></tr>
+        <tr><td>senf::log::IMPORTANT</td> <td>\c LOG_WARNING</td></tr>
+        <tr><td>senf::log::CRITICAL</td>  <td>\c LOG_CRIT</td></tr>
+        <tr><td>senf::log::FATAL</td>     <td>\c LOG_EMERG</td></tr>
+        </table>
+
         \ingroup targets
      */
     class SyslogTarget