[3121] Addressed review comments

Added suggested code commentary.

diff --git a/src/bin/d2/d2_config.cc b/src/bin/d2/d2_config.cc
index 1faa81900cb96c1eb87fa40c7925a2a68e39db07..fbfbf763d31dbb5c3c9d82c9a1b94371af0ed712 100644 (file)
--- a/src/bin/d2/d2_config.cc
+++ b/src/bin/d2/d2_config.cc
@@ -265,8 +265,9 @@ TSIGKeyInfoParser::createConfigParser(const std::string& config_id) {
 
 void
 TSIGKeyInfoParser::commit() {
-    /// @todo if at some point  TSIG keys need some form of resource
-    /// initialization do that here
+    /// @todo if at some point  TSIG keys need some form of runtime resource
+    /// initialization, such as creating some sort of hash instance in
+    /// crytpolib.  Once TSIG is fully implemented under Trac #3432 we'll know.
 }
 
 // *********************** TSIGKeyInfoListParser  *************************

diff --git a/src/bin/d2/d2_config.h b/src/bin/d2/d2_config.h
index 9babcd243a90d4afbc73bb9b200633ffb3fc0f83..5af60eee803626d7d2cef90f1f261cea939087eb 100644 (file)
--- a/src/bin/d2/d2_config.h
+++ b/src/bin/d2/d2_config.h
@@ -561,6 +561,8 @@ public:
     virtual isc::dhcp::ParserPtr createConfigParser(const std::string&
                                                     config_id);
     /// @brief Commits the TSIGKeyInfo configuration
+    /// Currently this method is a NOP, as the key instance is created and
+    /// then added to a local list of keys in build().
     virtual void commit();
 
 private:
@@ -613,7 +615,8 @@ public:
     /// @brief Commits the list of TSIG keys
     ///
     /// Iterates over the internal list of TSIGKeyInfoParsers, invoking
-    /// commit on each one.
+    /// commit on each one.  Then commits the local list of keys to
+    /// storage.
     virtual void commit();
 
 private:
@@ -675,6 +678,8 @@ public:
                                                     config_id);
 
     /// @brief Commits the configured DnsServerInfo
+    /// Currently this method is a NOP, as the server instance is created and
+    /// then added to the list of servers in build().
     virtual void commit();
 
 private:
@@ -788,6 +793,8 @@ public:
                                                     config_id);
 
     /// @brief Commits the configured DdnsDomain
+    /// Currently this method is a NOP, as the domain instance is created and
+    /// then added to the list of domains in build().
     virtual void commit();
 
 private:
@@ -920,6 +927,8 @@ public:
                                                     config_id);
 
     /// @brief Commits the configured DdsnDomainListMgr
+    /// Currently this method is a NOP, as the manager instance is created
+    /// in build().
     virtual void commit();
 
 private: