senfscons: Much improved install implementation

[senf.git] / Packets / ParseArray.hh

diff --git a/Packets/ParseArray.hh b/Packets/ParseArray.hh
index 2914c86..5260201 100644 (file)
--- a/Packets/ParseArray.hh
+++ b/Packets/ParseArray.hh
@@ -20,6 +20,9 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief ParseArray public header */
+
 #ifndef HH_ParseArray_
 #define HH_ParseArray_ 1
 
@@ -32,7 +35,12 @@
     collection parser, what kind of sequence is modelled (e.g. random access sequence, forward
     sequence etc). Most collections will also provide a kind of container wrapper to allow extensive
     manipulations of the collection contents. A container wrapper is initialized with the collection
-    parser and then provides a more complete sequence interface.
+    parser and then provides a more complete sequence interface. Additionally, the collection
+    wrapper has a longer lifetime than an ordinary parser: While a parser will be invalidated
+    whenever the collection is changed, the container wrapper will stay valid as long as the
+    collection is changed through the wrapper (directly or indirectly, where indirectly means that a
+    sub-field or sub-collection of the collection is changed). Some collections may provide even
+    more lifetime guarantees but this guarantee should be met by all collection wrappers.
 
     \important Parser lifetime has to be tightly checked when working with collection parsers since
     \e every change of the collections size will invalidate \e all parsers and iterators referencing
@@ -94,7 +102,7 @@ namespace senf {
 #if !defined(SENF_PACKETS_DECL_ONLY) && !defined(HH_ParseArray_i_)
 #define HH_ParseArray_i_
 //#include "ParseArray.cci"
-//#include "ParseArray.ct"
+#include "ParseArray.ct"
 #include "ParseArray.cti"
 #endif