From a6281448bd12f8dc74060032691d4ee4383488db Mon Sep 17 00:00:00 2001 From: Stefano Avallone Date: Fri, 19 Nov 2021 14:32:36 +0100 Subject: [PATCH] traffic-control: Fix doxygen warnings --- .../ns3tc/fq-cobalt-queue-disc-test-suite.cc | 83 ++++++++++++++++++- .../test/cobalt-queue-disc-test-suite.cc | 26 +++++- .../test/codel-queue-disc-test-suite.cc | 3 +- 3 files changed, 105 insertions(+), 7 deletions(-) diff --git a/src/test/ns3tc/fq-cobalt-queue-disc-test-suite.cc b/src/test/ns3tc/fq-cobalt-queue-disc-test-suite.cc index a75da72d0..c091984c8 100644 --- a/src/test/ns3tc/fq-cobalt-queue-disc-test-suite.cc +++ b/src/test/ns3tc/fq-cobalt-queue-disc-test-suite.cc @@ -155,6 +155,11 @@ public: private: virtual void DoRun (void); + /** + * Enqueue a packet. + * \param queue the queue disc + * \param hdr the IPv4 header + */ void AddPacket (Ptr queue, Ipv4Header hdr); }; @@ -224,6 +229,11 @@ public: private: virtual void DoRun (void); + /** + * Enqueue a packet. + * \param queue the queue disc + * \param hdr the IPv4 header + */ void AddPacket (Ptr queue, Ipv4Header hdr); }; @@ -366,6 +376,12 @@ public: private: virtual void DoRun (void); + /** + * Enqueue a packet. + * \param queue the queue disc + * \param ipHdr the IPv4 header + * \param tcpHdr the TCP header + */ void AddPacket (Ptr queue, Ipv4Header ipHdr, TcpHeader tcpHdr); }; @@ -452,6 +468,12 @@ public: private: virtual void DoRun (void); + /** + * Enqueue a packet. + * \param queue the queue disc + * \param ipHdr the IPv4 header + * \param udpHdr the UDP header + */ void AddPacket (Ptr queue, Ipv4Header ipHdr, UdpHeader udpHdr); }; @@ -551,9 +573,33 @@ public: private: virtual void DoRun (void); + /** + * Enqueue the given number of packets. + * \param queue the queue disc + * \param hdr the IPv4 header + * \param nPkt the number of packets + * \param nPktEnqueued the expected number of enqueued packets + * \param nQueueFlows the expected number of flow queues + */ void AddPacket (Ptr queue, Ipv4Header hdr, u_int32_t nPkt, u_int32_t nPktEnqueued, u_int32_t nQueueFlows); + /** + * Dequeue the given number of packets + * \param queue the queue disc + * \param nPkt the number of packets + */ void Dequeue (Ptr queue, uint32_t nPkt); + /** + * Dequeue the given number of packets at different times + * \param queue the queue disc + * \param delay the time between two consecutive dequeue operations + * \param nPkt the number of packets + */ void DequeueWithDelay (Ptr queue, double delay, uint32_t nPkt); + /** + * Tracer for the DropNext attribute + * \param oldVal old value + * \param newVal new value + */ void DropNextTracer (int64_t oldVal, int64_t newVal); uint32_t m_dropNextCount; ///< count the number of times m_dropNext is recalculated }; @@ -819,7 +865,7 @@ FqCobaltQueueDiscEcnMarking::DoRun (void) Simulator::Destroy (); } -/* +/** * This class tests linear probing, collision response, and set * creation capability of set associative hashing in FqCodel. * We modified DoClassify () and CheckProtocol () so that we could control @@ -839,8 +885,7 @@ FqCobaltQueueDiscEcnMarking::DoRun (void) * the hash. When a flow hash of 20 arrives, the value of outerhash * is 16. Since m_flowIndices[16] wasn’t previously allotted, a new flow * is created, and the tag corresponding to this queue is set to 20. -*/ - + */ class FqCobaltQueueDiscSetLinearProbing : public TestCase { public: @@ -848,6 +893,11 @@ public: virtual ~FqCobaltQueueDiscSetLinearProbing (); private: virtual void DoRun (void); + /** + * Enqueue a packet. + * \param queue the queue disc + * \param hdr the IPv4 header + */ void AddPacket (Ptr queue, Ipv4Header hdr); }; @@ -955,9 +1005,33 @@ public: private: virtual void DoRun (void); + /** + * Enqueue the given number of packets. + * \param queue the queue disc + * \param hdr the IPv4 header + * \param nPkt the number of packets + */ void AddPacket (Ptr queue, Ipv4Header hdr, u_int32_t nPkt); + /** + * Enqueue the given number of packets at different times. + * \param queue the queue disc + * \param hdr the IPv4 header + * \param delay the time between two consecutive enqueue operations + * \param nPkt the number of packets + */ void AddPacketWithDelay (Ptr queue,Ipv4Header hdr, double delay, uint32_t nPkt); + /** + * Dequeue the given number of packets + * \param queue the queue disc + * \param nPkt the number of packets + */ void Dequeue (Ptr queue, uint32_t nPkt); + /** + * Dequeue the given number of packets at different times + * \param queue the queue disc + * \param delay the time between two consecutive dequeue operations + * \param nPkt the number of packets + */ void DequeueWithDelay (Ptr queue, double delay, uint32_t nPkt); }; @@ -1103,6 +1177,9 @@ FqCobaltQueueDiscL4sMode::DoRun (void) } +/** + * FQ-COBALT queue disc test suite + */ class FqCobaltQueueDiscTestSuite : public TestSuite { public: diff --git a/src/traffic-control/test/cobalt-queue-disc-test-suite.cc b/src/traffic-control/test/cobalt-queue-disc-test-suite.cc index 98b7d1600..40958f727 100644 --- a/src/traffic-control/test/cobalt-queue-disc-test-suite.cc +++ b/src/traffic-control/test/cobalt-queue-disc-test-suite.cc @@ -46,9 +46,9 @@ public: * * \param p packet * \param addr address - * \param protocol + * \param protocol protocol + * \param ecnCapable ECN capable */ - CobaltQueueDiscTestItem (Ptr p, const Address & addr,uint16_t protocol, bool ecnCapable); virtual ~CobaltQueueDiscTestItem (); virtual void AddHeader (void); @@ -244,7 +244,14 @@ public: * \param mode the mode */ void RunDropTest (QueueSizeUnit mode); - + /** + * Enqueue the given number of packets, each of the given size, + * at different times. + * + * \param queue the queue disc + * \param size the packet size in bytes + * \param nPkt the number of packets + */ void EnqueueWithDelay (Ptr queue, uint32_t size, uint32_t nPkt); }; @@ -652,6 +659,11 @@ CobaltQueueDiscMarkTest::Dequeue (Ptr queue, uint32_t modeSize, class CobaltQueueDiscCeThresholdTest : public TestCase { public: + /** + * Constructor + * + * \param mode the queue size unit mode + */ CobaltQueueDiscCeThresholdTest (QueueSizeUnit mode); virtual ~CobaltQueueDiscCeThresholdTest (); @@ -817,6 +829,11 @@ CobaltQueueDiscCeThresholdTest::DoRun (void) class CobaltQueueDiscEnhancedBlueTest : public TestCase { public: + /** + * Constructor + * + * \param mode the queue size unit mode + */ CobaltQueueDiscEnhancedBlueTest (QueueSizeUnit mode); virtual ~CobaltQueueDiscEnhancedBlueTest (); @@ -933,6 +950,9 @@ CobaltQueueDiscEnhancedBlueTest::DequeueWithDelay (Ptr queue, u } +/** + * The COBALT queue disc test suite. + */ static class CobaltQueueDiscTestSuite : public TestSuite { public: diff --git a/src/traffic-control/test/codel-queue-disc-test-suite.cc b/src/traffic-control/test/codel-queue-disc-test-suite.cc index d5f1d4ff9..1e1709fab 100644 --- a/src/traffic-control/test/codel-queue-disc-test-suite.cc +++ b/src/traffic-control/test/codel-queue-disc-test-suite.cc @@ -370,8 +370,9 @@ public: virtual void DoRun (void); /** * Codel control law function - * \param queue the queue disc * \param t + * \param interval + * \param recInvSqrt * \returns the codel control law */ uint32_t _codel_control_law (uint32_t t, uint32_t interval, uint32_t recInvSqrt);