Browse Source

[trac742] Documentation comment

Michal 'vorner' Vaner 14 years ago
parent
commit
8081aaf24a
1 changed files with 13 additions and 0 deletions
  1. 13 0
      src/lib/cc/logger.h

+ 13 - 0
src/lib/cc/logger.h

@@ -18,14 +18,27 @@
 #include <cc/cc_messages.h>
 #include <log/macros.h>
 
+/// \file logger.h
+/// \brief Command Channel library global logger
+///
+/// This holds the logger for the CC library. It is a private header
+/// and should not be included in any publicly used header, only in local
+/// cc files.
+
 namespace isc {
 namespace cc {
 
 enum {
+    /// \brief Trace basic operation
     DBG_TRACE_BASIC = 10,
+    /// \brief Trace even details
+    ///
+    /// This includes messages being sent and received, waiting for messages
+    /// and alike.
     DBG_TRACE_DETAILED = 80
 };
 
+/// \brief Logger for this library
 extern isc::log::Logger logger;
 
 }