doc: fix some doxygen warnings

This commit is contained in:
Tommaso Pecorella
2021-12-02 02:34:38 +01:00
parent 3c604d5b2e
commit ad7ca1c5c1
3 changed files with 7 additions and 4 deletions

View File

@@ -87,7 +87,6 @@ public:
* the new bridge port NetDevice becomes part of the bridge and L2
* frames start being forwarded to/from this NetDevice.
*
* \param bridgePort NetDevice
* \attention The netdevice that is being added as bridge port must
* _not_ have an IP address. In order to add IP connectivity to a
* bridging node you must enable IP on the BridgeNetDevice itself,

View File

@@ -127,6 +127,7 @@ public:
virtual ~TrafficControlHelper () {}
/**
* \param nTxQueues the number of Tx queue disc classes
* \returns a new TrafficControlHelper with a default configuration
*
* The default configuration is an FqCoDelQueueDisc, if the device has a single
@@ -288,6 +289,7 @@ private:
* Actual implementation of the SetRootQueueDisc method.
*
* \param factory the factory used to create the root queue disc
* \returns zero on success
*/
uint16_t DoSetRootQueueDisc (ObjectFactory factory);

View File

@@ -106,6 +106,8 @@ public:
* Constructor
*
* \param tt the test type
* \param deviceQueueLength the queue length of the device
* \param totalTxPackets the toal number of packets to transmit
*/
TcFlowControlTestCase (QueueSizeUnit tt, uint32_t deviceQueueLength, uint32_t totalTxPackets);
virtual ~TcFlowControlTestCase ();
@@ -138,9 +140,9 @@ private:
* \param msg the message to print if a different number of packets are stored
*/
void CheckPacketsInQueueDisc (Ptr<NetDevice> dev, uint16_t nPackets, const std::string msg);
QueueSizeUnit m_type; //!< the test type
uint32_t m_deviceQueueLength;
uint32_t m_totalTxPackets;
QueueSizeUnit m_type; //!< the test type
uint32_t m_deviceQueueLength; //!< the queue length of the device
uint32_t m_totalTxPackets; //!< the toal number of packets to transmit
};
TcFlowControlTestCase::TcFlowControlTestCase (QueueSizeUnit tt, uint32_t deviceQueueLength, uint32_t totalTxPackets)