From: Mukund Sivaraman <muks@isc.org>
Date: Wed, 3 Oct 2012 04:30:06 +0000 (+0530)
Subject: [2206] Add a doc comment that getHeader() should never return NULL
X-Git-Tag: trac2351_base~24
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=14680316801f9274e5b4d099a4dfbf63d7cb110b;p=thirdparty%2Fkea.git

[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 6bf0d480a3..99cb051849 100644
--- 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 1313092b59..3cc65b7270 100644
--- 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);