documentation fixes.
tho [Wed, 17 Dec 2008 16:22:39 +0000 (16:22 +0000)]
git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1022 270642c3-0616-0410-b53a-bc976706d245

Packets/ListParser.dox
Packets/ListParser.hh

index d42310c..d2786b9 100644 (file)
@@ -36,8 +36,8 @@ namespace senf {
 
             // mandatory typedefs in the parser and container policy
             typedef ElementParser element_type;
-            typedef Parse_List< ExampleListPolicy > parser_type;
-            typedef Parse_List_Container< ExampleListPolicy > container_type;
+            typedef ListParser< ExampleListPolicy > parser_type;
+            typedef ListParser_Container< ExampleListPolicy > container_type;
 
             // mandatory constant in parser and container policy
             static const size_type init_bytes = 0;
@@ -85,10 +85,10 @@ namespace senf {
         typedef unspecified parser_type; ///< List parser type
                                         /**< parser_type is the list parser used to parse a list of
                                              this type,
-                                             e.g. <tt>senf::Parse_List<ExampleListPolicy></tt>. */
+                                             e.g. <tt>senf::ListParser<ExampleListPolicy></tt>. */
         typedef unspecified container_type; ///< Type of container wrapper
                                         /**< This is the container wrapper of the list, e.g.
-                                             <tt>Parse_List_Container<ExampleListPolicy></tt>. The
+                                             <tt>ListParser_Container<ExampleListPolicy></tt>. The
                                              container may however use a \e different policy, as
                                              long as that policy is constructible from the parser
                                              policy. */
index 004e77f..817ba48 100644 (file)
@@ -229,7 +229,7 @@ namespace senf {
         // The size field should be declared private or read-only (size is accessible via the list)
         SENF_PARSER_PRIVATE_FIELD ( list_size_, senf::UInt16Parser );
         // Define the list
-        SENF_PARSER_VECTOR ( list, list_size_, EltParser );
+        SENF_PARSER_LIST ( list, list_size_, EltParser );
         \endcode
         
         Here \c EltParser can be an arbitrary parser and need not have a fixed size.
@@ -267,7 +267,7 @@ namespace senf {
 
         The tags are applied to the \a size parameter:
         \code
-        SENF_PARSER_LIST ( vec, transform(MyTransform, list_size_), EltParser );
+        SENF_PARSER_LIST ( list, transform(MyTransform, list_size_), EltParser );
         \endcode
 
         \warning There are some caveats when working with \c bytes() type lists: