From: Thomas Markwalder <tmark@isc.org>
Date: Mon, 10 Dec 2018 17:05:30 +0000 (-0500)
Subject: [#278,!162] Addressed review comments
X-Git-Tag: 339-doxygen-errors_base~8^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=21dad40c94ebb91ba02e09f6758a16fbce5c8dbb;p=thirdparty%2Fkea.git

[#278,!162] Addressed review comments
---

diff --git a/doc/devel/mainpage.dox b/doc/devel/mainpage.dox
index ee16bfb66a..d2bb72bb3f 100644
--- a/doc/devel/mainpage.dox
+++ b/doc/devel/mainpage.dox
@@ -78,6 +78,7 @@
  *   - @subpage dhcpv6ConfigBackend
  *   - @subpage dhcpv6SignalBasedReconfiguration
  *   - @subpage dhcpv6Other
+ *   - @subpage dhcpv4o6Dhcp6
  * - @subpage congestionHandling
  * - @subpage d2
  *   - @subpage d2ProcessDerivation
diff --git a/src/lib/dhcp/packet_queue.h b/src/lib/dhcp/packet_queue.h
index e02be0dd74..64d1302294 100644
--- a/src/lib/dhcp/packet_queue.h
+++ b/src/lib/dhcp/packet_queue.h
@@ -41,8 +41,11 @@ enum class QueueEnd {
 /// This class serves as the abstract interface for packet queue
 /// implementations which may be used by @c IfaceMgr to store
 /// inbound packets until they are a dequeued for processing.
-/// @note Derivations of this class MUST BE thread-safe.
 ///
+/// @tparam PacktTypePtr Type of packet the queue contains.
+/// This expected to be either isc::dhcp::Pkt4Ptr or isc::dhcp::Pkt6Ptr
+///
+/// @note Derivations of this class MUST BE thread-safe.
 template<typename PacketTypePtr>
 class PacketQueue {
 public:
diff --git a/src/lib/dhcp/packet_queue_ring.h b/src/lib/dhcp/packet_queue_ring.h
index 4b66c5c109..4108896c62 100644
--- a/src/lib/dhcp/packet_queue_ring.h
+++ b/src/lib/dhcp/packet_queue_ring.h
@@ -18,7 +18,10 @@ namespace isc {
 
 namespace dhcp {
 
-/// @brief Provides an abstract ring-buffer implementation of the PacketQueue interface.
+/// @brief Provides a ring-buffer implementation of the PacketQueue interface.
+///
+/// @tparam PacktTypePtr Type of packet the queue contains.
+/// This expected to be either isc::dhcp::Pkt4Ptr or isc::dhcp::Pkt6Ptr
 template<typename PacketTypePtr>
 class PacketQueueRing : public PacketQueue<PacketTypePtr> {
 public:
@@ -66,11 +69,11 @@ public:
     /// @brief Determines if a packet should be discarded.
     ///
     /// This function is called in @c enqueuePackets for each packet
-    /// in its packet list. It provides an opportunity to examine the 
+    /// in its packet list. It provides an opportunity to examine the
     /// packet and its source and decide whether it should be dropped
-    /// or added to the queue. Derivations are expected to provide 
-    /// implementations based on their own requirements.  Bear in mind 
-    /// that the packet has NOT been unpacked at this point. The default 
+    /// or added to the queue. Derivations are expected to provide
+    /// implementations based on their own requirements.  Bear in mind
+    /// that the packet has NOT been unpacked at this point. The default
     /// implementation simply returns false (i.e. keep the packet).
     ///
     /// @return true if the packet should be dropped, false if it should be