[2206] Add a doc comment that getHeader() should never return NULL

diff --git a/src/lib/datasrc/memory/zone_table_segment.h b/src/lib/datasrc/memory/zone_table_segment.h
index 6bf0d480a3f4d2f45d34d5a0c4f947944f53b287..99cb0518493aede3ff6123f2e70fdfcf7bdd3643 100644 (file)
--- a/src/lib/datasrc/memory/zone_table_segment.h
+++ b/src/lib/datasrc/memory/zone_table_segment.h
@@ -64,6 +64,8 @@ public:
 
     /// \brief Return the ZoneTableHeader for the zone table segment.
     ///
+    /// NOTE: This method should never return \c NULL.
+    ///
     /// \return Returns the ZoneTableHeader for this zone table segment.
     virtual ZoneTableHeader* getHeader() = 0;
 

diff --git a/src/lib/datasrc/tests/memory/zone_table_segment_unittest.cc b/src/lib/datasrc/tests/memory/zone_table_segment_unittest.cc
index 1313092b5992a473ea4005fd581e2d7f3145126c..3cc65b72705857e0c14b8896ae39e61448af7bb1 100644 (file)
--- a/src/lib/datasrc/tests/memory/zone_table_segment_unittest.cc
+++ b/src/lib/datasrc/tests/memory/zone_table_segment_unittest.cc
@@ -36,6 +36,7 @@ TEST(ZoneTableSegment, getHeader) {
     auto_ptr<ZoneTableSegment>
         seg(ZoneTableSegment::create((*config.get())));
 
+    // getHeader() should never return NULL.
     ZoneTableHeader* header = seg->getHeader();
     EXPECT_NE(static_cast<void*>(NULL), header);