]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#278,!162] Minor doxygen clean up
authorThomas Markwalder <tmark@isc.org>
Fri, 7 Dec 2018 20:33:03 +0000 (15:33 -0500)
committerThomas Markwalder <tmark@isc.org>
Fri, 7 Dec 2018 20:33:03 +0000 (15:33 -0500)
doc/devel/congestion-handling.dox
src/lib/dhcp/packet_queue_ring.h

index a149661885a532ae77c18ba19af004a33bd1957c..3c1e8d06e17cc4e64fe71af603b740a268893163 100644 (file)
@@ -144,7 +144,7 @@ an isc::data::MapElement instance containing the contents of the configuration
 element "dhcp-queue-control" from the Kea server's configuration. It will
 always have the following two values:
 
--# "queue-enable" - used by isc::dhcp::IfaceMgr to know whether or not
+-# "enable-queue" - used by isc::dhcp::IfaceMgr to know whether or not
 congestion handling is enabled. Your implementation need not do anything
 with this value.
 
index cea139465d406b0fb1b72dfbb0288b4137e88332..4b66c5c1099784e662df01eb0af5648d1134a480 100644 (file)
@@ -73,9 +73,6 @@ public:
     /// that the packet has NOT been unpacked at this point. The default 
     /// implementation simply returns false (i.e. keep the packet).
     ///
-    /// @param packet the packet under consideration
-    /// @param source the socket the packet came from
-    ///
     /// @return true if the packet should be dropped, false if it should be
     /// kept.
     virtual bool shouldDropPacket(PacketTypePtr /* packet */,
@@ -92,12 +89,6 @@ public:
     /// based on their own requirements.  The default implemenation is to
     /// to simply return without skipping any packets.
     ///
-    /// @param from end of the queue from which packets should discarded
-    /// This is passed in from @c dequeuePackets.
-    ///
-    /// @param from specifies the end of the queue from which packets
-    /// should be discarded.
-    ///
     /// @return The number of packets discarded.
     virtual int eatPackets(const QueueEnd& /* from */) {
         return (0);