]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#99,!176] Updated commentary in the test config backend for DHCPv4.
authorMarcin Siodelski <marcin@isc.org>
Wed, 19 Dec 2018 12:40:59 +0000 (13:40 +0100)
committerMarcin Siodelski <marcin@isc.org>
Thu, 20 Dec 2018 19:47:42 +0000 (14:47 -0500)
src/lib/dhcpsrv/testutils/test_config_backend.h
src/lib/dhcpsrv/testutils/test_config_backend_dhcp4.h

index 7c644eb9f1b0735e38e26981bf7c3610a485ebfe..b82cc00b6a77b5c29bd196831b5ccb2eccbb4247 100644 (file)
@@ -52,7 +52,8 @@ public:
     /// @brief Returns backend type.
     ///
     /// @return string db_type name
-    virtual std::string getType() const { return (db_type_);
+    virtual std::string getType() const {
+        return (db_type_);
     }
 
     /// @brief Returns backend host.
index 34cb9fd8a94e26ada2475f0013274b7a6655b150..bd2aba62dce2e804a61ab6e7506410a57d5a539d 100644 (file)
@@ -14,7 +14,6 @@
 #include <dhcpsrv/testutils/test_config_backend.h>
 
 #include <boost/shared_ptr.hpp>
-#include <boost/lexical_cast.hpp>
 
 #include <map>
 #include <string>
@@ -23,19 +22,18 @@ namespace isc {
 namespace dhcp {
 namespace test {
 
-/// @brief Test backend that implements all of the DHCPv4 API calls
+/// @brief Test config backend that implements all of the DHCPv4 API calls
 ///
-/// Currently all API get calls which return a single entry, will return an
-/// empty pointer of appropriate type. API calls which return a collection of
-/// entires will return an empty collection of the appropriate type.
+/// This backend should be used for unit testing the DHCPv4 server and the
+/// commands which manpiluate the configuration information stored in the
+/// database.
 ///
-/// In addition provides static register and unregister methods so it may be
-/// registered with a configuration backend manager.
+/// This backend stores server configuration information in memory.
 class TestConfigBackendDHCPv4 : public TestConfigBackend<ConfigBackendDHCPv4> {
 public:
     /// @brief Constructor
     ///
-    ///
+    /// @param params Database connection parameters.
     TestConfigBackendDHCPv4(const db::DatabaseConnection::ParameterMap& params)
         : TestConfigBackend(params) {
     }