X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Utils%2FLogger%2FLog.hh;h=8a0794c18e02c81b739f33736229f6f6368365af;hb=412024ed31a4ab4eaea7a4165a434f8efebee325;hp=b206420b8755937ce5c49f2f7f6bd05f8090674f;hpb=f73fa16ed5abdce272ac77f8b8b9ef2b9922c266;p=senf.git

diff --git a/Utils/Logger/Log.hh b/Utils/Logger/Log.hh
index b206420..8a0794c 100644
--- a/Utils/Logger/Log.hh
+++ b/Utils/Logger/Log.hh
@@ -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 Log public header */
 
-#ifndef HH_Log_
-#define HH_Log_ 1
+#ifndef HH_SENF_Utils_Logger_Log_
+#define HH_SENF_Utils_Logger_Log_ 1
 
 // Custom includes
 #include <boost/preprocessor/seq/size.hpp>
@@ -39,7 +39,7 @@
 
 /** \defgroup logging Logging commands
 
-    The logging library provides several commands to create log messages. All these macro commands
+    The logging library provides several commands to create %log messages. All these macro commands
     take a variable number of arguments. Since this is not supported in a usable way by the C++
     preprocessor, the arguments are encoded into a <a
     href="http://www.boost.org/libs/preprocessor/doc/index.html">Boost.Preprocessor</a> like
@@ -49,13 +49,13 @@
     SENF_LOG( (senf::log::Debug)(senf::log::NOTICE)(FroblizerArea)("The log message") );
     \endcode
 
-    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>,
+    The argument is comprised of a sequence of parameters and the %log message itself. 
+    The parameters are
+    - the <em>%log stream</em>,
+    - the <em>%log area</em>,
+    - the <em>%log level</em>.
     
-    These parameters are optional and may be specified <i>in arbitrary order</i> (with the log
+    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.
@@ -69,20 +69,20 @@
     The logging library defines the global defaults for stream, area and level to be \c
     senf::log::Debug, senf::log::DefaultArea, and senf::log::NONE respectively.
 
-    The log level senf::log::NONE is special. If the log level is set to this value, the log level
+    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).
+    difficult for them to be something else).
 
     \section logging_aliases Aliases
 
     To further simplify logging commands, aliases may be defined within any scope. An alias is an
-    arbitrary collection of log parameters:
+    arbitrary collection of %log parameters:
     \code
-    SENF_LOG_DEF_ALIAS( VerboseDebug, (senf::log::Debug)(senf::log::VERBOSE) );
+    SENF_LOG_DEFINE_ALIAS( VerboseDebug, (senf::log::Debug)(senf::log::VERBOSE) );
     \endcode
-    Within log statements, aliases may be used like normal parameters. They will be substituted for
+    Within %log statements, aliases may be used like normal parameters. They will be substituted for
     the parameter sequence they represent:
     \code
     SENF_LOG( (VerboseDebug)("Debug message") )
@@ -92,7 +92,7 @@
     Aliases may be used together with other parameters, even with further aliases in any order.
  */
 
-///\ingroup logging
+///\addtogroup logging
 ///\{
 
 ///\name Generating log messages