From: Marcin Siodelski Date: Mon, 10 Dec 2018 16:28:50 +0000 (+0100) Subject: [#278,!162] Further minor changes in Congestion Handling text. X-Git-Tag: 339-doxygen-errors_base~8^2~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=414b2d8aa5036deaec4dd5da16313f271bcb736e;p=thirdparty%2Fkea.git [#278,!162] Further minor changes in Congestion Handling text. --- diff --git a/doc/devel/congestion-handling.dox b/doc/devel/congestion-handling.dox index 5187bdf7e6..058a3a7f41 100644 --- a/doc/devel/congestion-handling.dox +++ b/doc/devel/congestion-handling.dox @@ -76,7 +76,7 @@ isc::dhcp::PacketQueue. The class is almost entirely abstract and deliberately brief to provide developers wide latitude in the internals of their solutions. -The template argument, PacketTypePtr, is expected to be either +The template argument, @c PacketTypePtr, is expected to be either isc::dhcp::Pkt4Ptr or isc::dhcp::Pkt6Ptr, depending upon which protocol the implementation will handle. Please note that the while following text and examples largely focus on DHCPv4 out @@ -107,7 +107,7 @@ The remaining functions that you'll need to implement are self-explanatory. How your actual "queue" is implemented is entirely up to you. Kea's default implementation using a ring buffer based on Boost's boost::circular_buffer (please refer to isc::dhcp::PacketQueueRing, isc::dhcp::PacketQueueRing4 and -isc::dhcpPacketQueueRing6). The most critical aspects to remember when +isc::dhcp::PacketQueueRing6). The most critical aspects to remember when developing your implementation are: -# It MUST be thread safe since queuing and dequeing packets are done by @@ -277,7 +277,7 @@ int unload() { } @endcode -@subsection packet-queue-factory Configuring Kea to use Your PacketQueue<> +@subsection packet-queue-factory Configuring Kea to use YourPacketQueue4 You're almost there. You developed your implementation, you've unit tested it (You did unit test it right?). Now you just have to tell Kea to load it and