Browse Source

[2835] (minor) Docs, comments

Michal 'vorner' Vaner 12 years ago
parent
commit
fe630ca4be
2 changed files with 6 additions and 1 deletions
  1. 5 0
      src/lib/datasrc/client_list.h
  2. 1 1
      src/lib/datasrc/tests/client_list_unittest.cc

+ 5 - 0
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) {

+ 1 - 1
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());