[2835] (minor) Docs, comments

diff --git a/src/lib/datasrc/client_list.h b/src/lib/datasrc/client_list.h
index c0874948838b892c0f153425ff4b909a8efc36e9..256ad3622ec05448c1dc67033ea699ed8f204bc1 100644 (file)
--- a/src/lib/datasrc/client_list.h
+++ b/src/lib/datasrc/client_list.h
@@ -92,6 +92,11 @@ public:
 
     /// \brief Get the segment type
     ///
+    /// \note Specific values of the type are only meaningful for the
+    ///     corresponding memory segment implementation and modules that
+    ///     directly manage the segments. Other normal applications should
+    ///     treat them as opaque identifiers.
+    ///
     /// \throw isc::InvalidOperation if called and state is SEGMENT_UNUSED.
     const std::string& getSegmentType() const {
         if (getSegmentState() == SEGMENT_UNUSED) {

diff --git a/src/lib/datasrc/tests/client_list_unittest.cc b/src/lib/datasrc/tests/client_list_unittest.cc
index 821b24f8dbf009e17ae1c9d5e79e6eeb43d87dda..bc2d4f122553810bf98e5fa5321cf35b704c1bd0 100644 (file)
--- a/src/lib/datasrc/tests/client_list_unittest.cc
+++ b/src/lib/datasrc/tests/client_list_unittest.cc
@@ -1163,7 +1163,7 @@ TYPED_TEST(ReloadTest, reloadMasterFile) {
                                                          RRType::TXT())->code);
 }
 
-// Check the status holds data and can change the segment state
+// Check the status holds data
 TEST(DataSourceStatus, status) {
     const DataSourceStatus status("Test", SEGMENT_INUSE, "local");
     EXPECT_EQ("Test", status.getName());