Skip to content
Snippets Groups Projects
Commit c18bfc6f authored by tho's avatar tho
Browse files

documentation fixes.

parent 0b9fdfa0
No related branches found
No related tags found
No related merge requests found
...@@ -36,8 +36,8 @@ namespace senf { ...@@ -36,8 +36,8 @@ namespace senf {
// mandatory typedefs in the parser and container policy // mandatory typedefs in the parser and container policy
typedef ElementParser element_type; typedef ElementParser element_type;
typedef Parse_List< ExampleListPolicy > parser_type; typedef ListParser< ExampleListPolicy > parser_type;
typedef Parse_List_Container< ExampleListPolicy > container_type; typedef ListParser_Container< ExampleListPolicy > container_type;
// mandatory constant in parser and container policy // mandatory constant in parser and container policy
static const size_type init_bytes = 0; static const size_type init_bytes = 0;
...@@ -85,10 +85,10 @@ namespace senf { ...@@ -85,10 +85,10 @@ namespace senf {
typedef unspecified parser_type; ///< List parser type typedef unspecified parser_type; ///< List parser type
/**< parser_type is the list parser used to parse a list of /**< parser_type is the list parser used to parse a list of
this type, 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 typedef unspecified container_type; ///< Type of container wrapper
/**< This is the container wrapper of the list, e.g. /**< 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 container may however use a \e different policy, as
long as that policy is constructible from the parser long as that policy is constructible from the parser
policy. */ policy. */
......
...@@ -229,7 +229,7 @@ namespace senf { ...@@ -229,7 +229,7 @@ namespace senf {
// The size field should be declared private or read-only (size is accessible via the list) // The size field should be declared private or read-only (size is accessible via the list)
SENF_PARSER_PRIVATE_FIELD ( list_size_, senf::UInt16Parser ); SENF_PARSER_PRIVATE_FIELD ( list_size_, senf::UInt16Parser );
// Define the list // Define the list
SENF_PARSER_VECTOR ( list, list_size_, EltParser ); SENF_PARSER_LIST ( list, list_size_, EltParser );
\endcode \endcode
Here \c EltParser can be an arbitrary parser and need not have a fixed size. Here \c EltParser can be an arbitrary parser and need not have a fixed size.
...@@ -267,7 +267,7 @@ namespace senf { ...@@ -267,7 +267,7 @@ namespace senf {
The tags are applied to the \a size parameter: The tags are applied to the \a size parameter:
\code \code
SENF_PARSER_LIST ( vec, transform(MyTransform, list_size_), EltParser ); SENF_PARSER_LIST ( list, transform(MyTransform, list_size_), EltParser );
\endcode \endcode
\warning There are some caveats when working with \c bytes() type lists: \warning There are some caveats when working with \c bytes() type lists:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment