X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FParseListN.hh;h=9151a6112e228a9492b2b8690ae21755cb9592e1;hb=81ffa1c459b96dd44472bcef37e1e373934ee138;hp=8dc224349061147bc1d006cfb9877a1fbb57c98e;hpb=2d6585ff852e9d282c17003ba1db0b73eb3a8500;p=senf.git

diff --git a/Packets/ParseListN.hh b/Packets/ParseListN.hh
index 8dc2243..9151a61 100644
--- a/Packets/ParseListN.hh
+++ b/Packets/ParseListN.hh
@@ -1,3 +1,4 @@
+
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
@@ -35,6 +36,20 @@ namespace senf {
     namespace detail { template <class ElementParser, class SizeParser>
                        class Parse_ListN_Policy; }
 
+    /** \brief List parser with size-field giving number of list elements
+
+        This parser will parse a list which size is giving by a preceding field containing the
+        number of list elements. This struct is just a 'template typedef':
+        \code
+        senf::Parse_VectorN< Parser_UInt32, Parser_UInt16 >::parser Parse_MyVector;
+        senf::Parse_ListN< Parse_MyVector, Parse_UInt16 >::parser Parse_MyList;
+        \endcode
+        This first defines a Vector of 32 bit unsigned integers with 16 bit length counter. Then it
+        defines a list of such vectors with a 16 bit size field.
+
+        \see Parse_List
+        \ingroup parsecollection
+     */
     template <class ElementParser, class SizeParser>
     struct Parse_ListN {
         typedef Parse_List< detail::Parse_ListN_Policy<ElementParser,SizeParser> > parser;