BIND 10 trac2207, updated. 1ae2321d7183470ad3540d2a92436893724ea773 [2207] Better documentation for LoadAction

[BIND 10 source code commits]

The branch, trac2207 has been updated
       via  1ae2321d7183470ad3540d2a92436893724ea773 (commit)
      from  03b8bddd309adeb39a99474aea530f05989b99ed (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 1ae2321d7183470ad3540d2a92436893724ea773
Author: Michal 'vorner' Vaner <michal.vaner at nic.cz>
Date:   Wed Oct 17 11:58:51 2012 +0200

    [2207] Better documentation for LoadAction

-----------------------------------------------------------------------

Summary of changes:
 src/lib/datasrc/memory/load_action.h |   11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

-----------------------------------------------------------------------
diff --git a/src/lib/datasrc/memory/load_action.h b/src/lib/datasrc/memory/load_action.h
index e5fe004..f9625af 100644
--- a/src/lib/datasrc/memory/load_action.h
+++ b/src/lib/datasrc/memory/load_action.h
@@ -28,9 +28,14 @@ class ZoneData;
 
 /// \brief Callback to load data into the memory
 ///
-/// This callback should create new ZoneData (allocated from the passed
-/// memory segment) and fill it with relevant loaded data. The caller
-/// of the callback takes ownership of the ZoneData.
+/// This is called from the ZoneWriter whenever there's need to load the
+/// zone data. The callback should allocate new ZoneData and fill it with
+/// the zone content. It is up to the callback to know where or how to
+/// load the data, or even the origin and class of the zone (it is assumed
+/// the callback will be some kind of functor).
+///
+/// All data should be allocated from the passed MemorySegment. The ownership
+/// is passed onto the caller.
 ///
 /// It must not return NULL.
 typedef boost::function<ZoneData*(util::MemorySegment&)> LoadAction;