From: tho Date: Tue, 5 Feb 2008 14:53:59 +0000 (+0000) Subject: small documentation fixes X-Git-Url: http://g0dil.de/git?p=senf.git;a=commitdiff_plain;h=6a9425b523ea9a2bd41103dd10659ac8c7c0d080 small documentation fixes git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@664 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/Examples/RateStuffer/Mainpage.dox b/Examples/RateStuffer/Mainpage.dox index 51b2ce7..fcc7303 100644 --- a/Examples/RateStuffer/Mainpage.dox +++ b/Examples/RateStuffer/Mainpage.dox @@ -111,7 +111,7 @@ \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 throttling events. The timer is registered to call RateFilter::timeout(). diff --git a/Packets/ListParser.dox b/Packets/ListParser.dox index 7d190b5..fd20833 100644 --- a/Packets/ListParser.dox +++ b/Packets/ListParser.dox @@ -71,7 +71,7 @@ namespace senf { additionally needs erase() and insert(). The container policy will also need the element_type, parser_type and container_type typedefs. - \see \ref Parse_List + \see \ref ListParser */ struct ExampleListPolicy { @@ -126,7 +126,7 @@ namespace senf { /** \brief Example of a list iterator policy. ONLY FOR EXPOSITION. \see \ref ExampleListPolicy \n - \ref Parse_List + \ref ListParser */ struct iterator_policy { @@ -167,7 +167,7 @@ namespace senf { /** \brief Example of a list container policy. ONLY FOR EXPOSITION \see \ref ExampleListPolicy \n - \ref Parse_List + \ref ListParser */ struct container_policy { diff --git a/Packets/ParseHelpers.hh b/Packets/ParseHelpers.hh index e86818c..31fa8b5 100644 --- a/Packets/ParseHelpers.hh +++ b/Packets/ParseHelpers.hh @@ -660,7 +660,7 @@ arbitrary incorrect value otherwise. \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 \hideinitializer */ diff --git a/Utils/Logger/Config.hh b/Utils/Logger/Config.hh index ac51c7a..80d02cb 100644 --- a/Utils/Logger/Config.hh +++ b/Utils/Logger/Config.hh @@ -46,7 +46,7 @@ Runtime 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 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 diff --git a/Utils/auto_unit_test.hh b/Utils/auto_unit_test.hh index 7e838a2..0651fde 100644 --- a/Utils/auto_unit_test.hh +++ b/Utils/auto_unit_test.hh @@ -28,7 +28,7 @@ any necessary workarounds. So, instead of \#include , you should always write - \#include "../Utils/auto_unit_test.hh" (with possibliy adjusted path). + \#include "../Utils/auto_unit_test.hh" (with possibliy adjusted path). */ #ifndef HH_auto_unit_test_