From: Michal 'vorner' Vaner <michal.vaner@nic.cz>
Date: Wed, 27 Mar 2013 09:10:48 +0000 (+0100)
Subject: [2835] (minor) Docs, comments
X-Git-Tag: bind10-1.1.0beta1-release~23^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=fe630ca4be50f0f0bd048eec264b8a21df9c6b38;p=thirdparty%2Fkea.git

[2835] (minor) Docs, comments
---

diff --git a/src/lib/datasrc/client_list.h b/src/lib/datasrc/client_list.h
index c087494883..256ad3622e 100644
--- 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 821b24f8db..bc2d4f1225 100644
--- 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());