Changeset 71 in pacpusframework for trunk/include/Pacpus/kernel/Log.h

Timestamp:

01/10/13 15:07:34 (11 years ago)

Author:

Marek Kurdej

Message:

Added: more documentation.
doc/doxyfile.in: turned on BUILTIN_STL_SUPPORT in Doxygen.
Added: LICENSE-header.txt to be included in all source files.

File:

• trunk/include/Pacpus/kernel/Log.h (modified) (3 diffs)

trunk/include/Pacpus/kernel/Log.h

@@ -19 +19 @@
 namespace pacpus {
 
+/// Static log facility initializer
+///
+/// Uses Schwarz counter (nifty counter) idiom to initialize the log before
+/// other static objects that could use the log.
 static class PACPUSLIB_API LogConfigurator
 {
@@ -31 +35 @@
 
 #ifdef PACPUS_USE_LOG
-  // Includes, log4cxx.
   #include <log4cxx/logger.h>
 
   class QString;
-
-  /** Declare a log4cxx logger
-   * @param name Name of the logger, displayed when logging a message.
-   */
+  
   #define DECLARE_STATIC_LOGGER(name) \
     static log4cxx::LoggerPtr logger(log4cxx::Logger::getLogger(name))
 
-  // Macros making logging user friendly.
   #define LOG_TRACE(message)          LOG4CXX_TRACE(logger, message)
   #define LOG_DEBUG(message)          LOG4CXX_DEBUG(logger, message)
@@ -50 +49 @@
   #define LOG_FATAL(message)          LOG4CXX_FATAL(logger, message)
 
-  // Provides helpers to log a QString.
+  /// Output stream ::log4cxx::helpers::CharMessageBuffer operator for QString
   PACPUSLIB_API ::log4cxx::helpers::CharMessageBuffer & operator<<(::log4cxx::helpers::CharMessageBuffer & os, const QString & s);
+  /// Output stream ::log4cxx::helpers::MessageBuffer operator for QString
   PACPUSLIB_API ::log4cxx::helpers::CharMessageBuffer & operator<<(::log4cxx::helpers::MessageBuffer & os, const QString & s);
+
 #else
+  /// Declares a log4cxx logger
+  ///
+  /// @param name Name of the logger, displayed when logging a message.
   #define DECLARE_STATIC_LOGGER(name)
+  /// Logs a message at TRACE level using default logger
   #define LOG_TRACE(message)
+  /// Logs a message at DEBUG level using default logger
   #define LOG_DEBUG(message)
+  /// Logs a message at INFO level using default logger
   #define LOG_INFO(message)
+  /// Logs a message at WARN level using default logger
   #define LOG_WARN(message)
+  /// Logs a message at ERROR level using default logger
   #define LOG_ERROR(message)
+  /// Logs a message at FATAL level using default logger
   #define LOG_FATAL(message)
 #endif // PACPUS_USE_LOG