Commit 1ae2321d authored by Michal 'vorner' Vaner's avatar Michal 'vorner' Vaner
Browse files

[2207] Better documentation for LoadAction

parent 03b8bddd
......@@ -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;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment