From: g0dil <g0dil@270642c3-0616-0410-b53a-bc976706d245>
Date: Fri, 3 Oct 2008 08:58:17 +0000 (+0000)
Subject: Utils/Logger: SyslogTarget documentation
X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=9a074ebd4b82022bfe686b40de8db80927def2b8;p=senf.git

Utils/Logger: SyslogTarget documentation

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@924 270642c3-0616-0410-b53a-bc976706d245
---

diff --git a/Utils/Logger/SyslogTarget.hh b/Utils/Logger/SyslogTarget.hh
index bb1aa6c..70cf4e3 100644
--- a/Utils/Logger/SyslogTarget.hh
+++ b/Utils/Logger/SyslogTarget.hh
@@ -36,15 +36,27 @@
 namespace senf {
 namespace log {
     
+    /** \brief Log target writing to the syslog
+
+        The SyslogTarget will send all log messages to the syslog at the given facility.
+
+        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>,
+           <tt>LOG_KERN</tt>, <tt>LOG_LOCAL0</tt>, <tt>LOG_LOCAL1</tt>, <tt>LOG_LOCAL2</tt>,
+           <tt>LOG_LOCAL3</tt>, <tt>LOG_LOCAL4</tt>, <tt>LOG_LOCAL5</tt>, <tt>LOG_LOCAL6</tt>,
+           <tt>LOG_LOCAL7</tt>, <tt>LOG_LPR</tt>, <tt>LOG_MAIL</tt>, <tt>LOG_NEWS</tt>,
+           <tt>LOG_SYSLOG</tt>, <tt>LOG_USER</tt>, <tt>LOG_UUCP</tt>
+
+        The default facility is <tt>LOG_USER</tt>.
+
+        \ingroup targets
+     */
     class SyslogTarget 
         : public Target
     {
     public:
         ///////////////////////////////////////////////////////////////////////////
-        // Types
-
-
-        ///////////////////////////////////////////////////////////////////////////
         ///\name Structors and default members
         ///@{
 
@@ -53,12 +65,11 @@ namespace log {
         ///@}
         ///////////////////////////////////////////////////////////////////////////
 
-    protected:
+    private:
         void v_write(time_type timestamp, std::string const & stream, 
                      std::string const & area, unsigned level, 
                      std::string const & message);
 
-    private:
         int facility_;
         static int const LEVELMAP_[8];
     };