Packets: Fix VariantParser invalid parser access bug
[senf.git] / Utils / Logger / FileTarget.hh
index 45f1bd0..5c4cc34 100644 (file)
@@ -1,8 +1,8 @@
 // $Id$
 //
-// Copyright (C) 2007 
-// Fraunhofer Institute for Open Communication Systems (FOKUS) 
-// Competence Center NETwork research (NET), St. Augustin, GERMANY 
+// Copyright (C) 2007
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
@@ -23,8 +23,8 @@
 /** \file
     \brief FileTarget public header */
 
-#ifndef HH_FileTarget_
-#define HH_FileTarget_ 1
+#ifndef HH_SENF_Utils_Logger_FileTarget_
+#define HH_SENF_Utils_Logger_FileTarget_ 1
 
 // Custom includes
 #include <boost/utility.hpp>
@@ -42,6 +42,13 @@ namespace log {
         The FileTarget will save all %log messages in the given file. Messages will be appended at
         the end of the file.
 
+        \code
+        senf::log::FileTarget target ("file.name");
+        
+        // Route all messages to this file.
+        target.route();
+        \endcode
+
         After %log files have been rotated, the reopen() member should be called to create a new %log
         file.