wifi: Fix documentation on WifiPhy traces

This commit is contained in:
Nihar Kapasi
2025-01-19 10:39:55 +05:30
committed by Tom Henderson
parent a1e5d6fbd3
commit ca702cff5f
2 changed files with 13 additions and 4 deletions

View File

@@ -351,7 +351,7 @@ WifiPhy::GetTypeId()
"Trace source indicating a packet "
"has been dropped by the device during reception",
MakeTraceSourceAccessor(&WifiPhy::m_phyRxDropTrace),
"ns3::Packet::TracedCallback")
"ns3::WifiPhy::PhyRxDropTracedCallback")
.AddTraceSource("PhyRxPpduDrop",
"Trace source indicating a ppdu "
"has been dropped by the device during reception",

View File

@@ -746,14 +746,23 @@ class WifiPhy : public Object
typedef void (*PhyRxPayloadBeginTracedCallback)(WifiTxVector txVector, Time psduDuration);
/**
* TracedCallback signature for start of PSDU reception events.
* TracedCallback signature for PhyRxPpduDrop trace source.
*
* @param txVector the TXVECTOR decoded from the PHY header
* @param psduDuration the duration of the PSDU
* @param ppdu the ppdu being received
* @param reason the reason the ppdu was dropped
*/
typedef void (*PhyRxPpduDropTracedCallback)(Ptr<const WifiPpdu> ppdu,
WifiPhyRxfailureReason reason);
/**
* TracedCallback signature for PhyRxDrop trace source.
*
* @param packet the packet being received
* @param reason the reason the packet was dropped
*/
typedef void (*PhyRxDropTracedCallback)(Ptr<const Packet> packet,
WifiPhyRxfailureReason reason);
/**
* TracedCallback signature for end of MAC header reception events.
*