From: Tomek Mrugalski <tomasz@isc.org>
Date: Fri, 30 May 2014 13:06:45 +0000 (+0200)
Subject: [3399] Updated comments in kea_controller_unittest.cc
X-Git-Tag: trac3434_base~15^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=fe739cf85387e170c935cb9cfb92155a0efd31e8;p=thirdparty%2Fkea.git

[3399] Updated comments in kea_controller_unittest.cc
---

diff --git a/src/bin/dhcp4/tests/kea_controller_unittest.cc b/src/bin/dhcp4/tests/kea_controller_unittest.cc
index 756314838b..6bda818ada 100644
--- a/src/bin/dhcp4/tests/kea_controller_unittest.cc
+++ b/src/bin/dhcp4/tests/kea_controller_unittest.cc
@@ -47,7 +47,10 @@ public:
 
 /// @brief test class for Kea configuration backend
 ///
-/// This class is used for testing
+/// This class is used for testing Kea configuration backend.
+/// It is very simple and currently focuses on reading
+/// config file from disk. It is expected to be expanded in the
+/// near future.
 class JSONFileBackendTest : public ::testing::Test {
 public:
     JSONFileBackendTest() {
@@ -57,6 +60,12 @@ public:
         static_cast<void>(unlink(TEST_FILE));
     };
 
+    /// @brief writes specified content to a well known file
+    ///
+    /// Writes specified content to TEST_FILE. Tests will
+    /// attempt to read that file.
+    ///
+    /// @param content content to be written to file
     void writeFile(const std::string& content) {
         static_cast<void>(unlink(TEST_FILE));
 
@@ -66,10 +75,11 @@ public:
         out.close();
     }
 
+    /// Name of a config file used during tests
     static const char* TEST_FILE;
 };
 
-const char* JSONFileBackendTest::TEST_FILE = "test-config.json";
+const char* JSONFileBackendTest::TEST_FILE  = "test-config.json";
 
 // This test checks if configuration can be read from a JSON file.
 TEST_F(JSONFileBackendTest, jsonFile) {