Browse Source

[3048] Changes to comments after review

Stephen Morris 11 years ago
parent
commit
ca9233574b
2 changed files with 6 additions and 6 deletions
  1. 4 4
      src/lib/hooks/server_hooks.cc
  2. 2 2
      src/lib/hooks/server_hooks.h

+ 4 - 4
src/lib/hooks/server_hooks.cc

@@ -28,10 +28,10 @@ namespace hooks {
 // Constructor - register the pre-defined hooks and check that the indexes
 // assigned to them are as expected.
 //
-// Note that there are no logging messages here or in registerHooks().  One
-// method to initialize hook names is to use static initialization.  Here,
-// a static object is declared in a file outside of any function or method.
-// As a result, it is instantiated and its constructor run before the main
+// Note that there are no logging messages here or in registerHooks().  The
+// recommended way to initialize hook names is to use static initialization.
+// Here, a static object is declared in a file outside of any function or
+// method.  As a result, it is instantiated and its constructor run before the
 // program starts.  By putting calls to ServerHooks::registerHook() in there,
 // hooks names are already registered when the program runs.  However, at that
 // point, the logging system is not initialized, so messages are unable to

+ 2 - 2
src/lib/hooks/server_hooks.h

@@ -149,7 +149,7 @@ private:
     /// for the packet has completed.  They allow the server code to allocate
     /// and destroy per-packet context.
     ///
-    /// Constructor is declared private to enforce the singleton nature of
+    /// The constructor is declared private to enforce the singleton nature of
     /// the object.  A reference to the singleton is obtainable through the
     /// getServerHooks() static method.
     ///
@@ -160,7 +160,7 @@ private:
     /// @brief Initialize hooks
     ///
     /// Sets the collection of hooks to the initial state, with just the
-    /// context_create and context_destroy hooks set.  This used during
+    /// context_create and context_destroy hooks set.  This is used during
     /// construction.
     ///
     /// @throws isc::Unexpected if the registration of the pre-defined hooks