From: Michal 'vorner' Vaner <michal.vaner@nic.cz>
Date: Wed, 17 Oct 2012 10:23:33 +0000 (+0200)
Subject: [2207] Update docs of ZoneWriterLocal
X-Git-Tag: trac2402_base~12^2~16
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2530e97e662406cb168e80358c764ff8692866cb;p=thirdparty%2Fkea.git

[2207] Update docs of ZoneWriterLocal

They were outdated, for previous version of the interface.
---

diff --git a/src/lib/datasrc/memory/zone_writer_local.h b/src/lib/datasrc/memory/zone_writer_local.h
index 6a92056772..10101f437d 100644
--- a/src/lib/datasrc/memory/zone_writer_local.h
+++ b/src/lib/datasrc/memory/zone_writer_local.h
@@ -49,10 +49,9 @@ public:
 
     /// \brief Loads the data.
     ///
-    /// This prepares an empty ZoneData and calls load_action (passed to
-    /// constructor) to fill it with data.
+    /// This calls the load_action (passed to constructor) and stores the
+    /// data for future use.
     ///
-    /// \throw std::bad_alloc If there's a problem allocating the ZoneData.
     /// \throw isc::Unexpected if it is called the second time in lifetime
     ///     of the object.
     /// \throw Whatever the load_action throws, it is propagated up.
@@ -60,7 +59,8 @@ public:
 
     /// \brief Installs the zone.
     ///
-    /// This simply calls the install_action.
+    /// It modifies the zone table accessible through the segment (passed to
+    /// constructor).
     ///
     /// \throw isc::Unexpected if it is called the second time in lifetime
     ///     of the object or if load() was not called previously or if