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

small documentation fixes

parent a525e2b9
No related branches found
No related tags found
No related merge requests found
...@@ -111,7 +111,7 @@ ...@@ -111,7 +111,7 @@
\until } \until }
The event is initialized to fire eery \a interval nanoseconds. The traffic is routed 'across' The event is initialized to fire every \a interval nanoseconds. The traffic is routed 'across'
the timer which controls the traffic. This routing lets the module automatically handle the timer which controls the traffic. This routing lets the module automatically handle
throttling events. The timer is registered to call RateFilter::timeout(). throttling events. The timer is registered to call RateFilter::timeout().
......
...@@ -71,7 +71,7 @@ namespace senf { ...@@ -71,7 +71,7 @@ namespace senf {
additionally needs erase() and insert(). The container policy will also need the additionally needs erase() and insert(). The container policy will also need the
element_type, parser_type and container_type typedefs. element_type, parser_type and container_type typedefs.
\see \ref Parse_List \see \ref ListParser
*/ */
struct ExampleListPolicy struct ExampleListPolicy
{ {
...@@ -126,7 +126,7 @@ namespace senf { ...@@ -126,7 +126,7 @@ namespace senf {
/** \brief Example of a list iterator policy. ONLY FOR EXPOSITION. /** \brief Example of a list iterator policy. ONLY FOR EXPOSITION.
\see \ref ExampleListPolicy \n \see \ref ExampleListPolicy \n
\ref Parse_List \ref ListParser
*/ */
struct iterator_policy struct iterator_policy
{ {
...@@ -167,7 +167,7 @@ namespace senf { ...@@ -167,7 +167,7 @@ namespace senf {
/** \brief Example of a list container policy. ONLY FOR EXPOSITION /** \brief Example of a list container policy. ONLY FOR EXPOSITION
\see \ref ExampleListPolicy \n \see \ref ExampleListPolicy \n
\ref Parse_List \ref ListParser
*/ */
struct container_policy struct container_policy
{ {
......
...@@ -660,7 +660,7 @@ ...@@ -660,7 +660,7 @@
arbitrary incorrect value otherwise. arbitrary incorrect value otherwise.
\pre Field \a name preceded by fixed size fields only \pre Field \a name preceded by fixed size fields only
\param[in] field or label name \param[in] name field or label name
\returns compile-time constant offset of the field from parsers start \returns compile-time constant offset of the field from parsers start
\hideinitializer \hideinitializer
*/ */
......
...@@ -46,7 +46,7 @@ ...@@ -46,7 +46,7 @@
<em>Runtime</em> configuration on the other hand deals with routing all those messages, which <em>Runtime</em> configuration on the other hand deals with routing all those messages, which
are enabled at compile time to the logging targets. If a message is not routed, it will be are enabled at compile time to the logging targets. If a message is not routed, it will be
discarded. This allows to additionally disable messages at run-time. Message routing is managed discarded. This allows to additionally disable messages at run-time. Message routing is managed
via the \ref Targets interface. via the ::Target interface.
\section config_compile Compile time configuration \section config_compile Compile time configuration
......
...@@ -28,7 +28,7 @@ ...@@ -28,7 +28,7 @@
any necessary workarounds. any necessary workarounds.
So, instead of <tt>\#include <boost/test/auto_unit_test.hpp></tt>, you should always write So, instead of <tt>\#include <boost/test/auto_unit_test.hpp></tt>, you should always write
<tt>\#include "../Utils/auto_unit_test.hh"<tt> (with possibliy adjusted path). <tt>\#include "../Utils/auto_unit_test.hh"</tt> (with possibliy adjusted path).
*/ */
#ifndef HH_auto_unit_test_ #ifndef HH_auto_unit_test_
......
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