From: tho Date: Wed, 17 Dec 2008 16:22:39 +0000 (+0000) Subject: documentation fixes. X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=518642ccd4fafcbc944cd09512d9f3ea37097427;p=senf.git documentation fixes. git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1022 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/Packets/ListParser.dox b/Packets/ListParser.dox index d42310c..d2786b9 100644 --- a/Packets/ListParser.dox +++ b/Packets/ListParser.dox @@ -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. senf::Parse_List. */ + e.g. senf::ListParser. */ typedef unspecified container_type; ///< Type of container wrapper /**< This is the container wrapper of the list, e.g. - Parse_List_Container. The + ListParser_Container. The container may however use a \e different policy, as long as that policy is constructible from the parser policy. */ diff --git a/Packets/ListParser.hh b/Packets/ListParser.hh index 004e77f..817ba48 100644 --- a/Packets/ListParser.hh +++ b/Packets/ListParser.hh @@ -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: