From bca75201d968ef07ad3e5fc5e402285684b2a8ae Mon Sep 17 00:00:00 2001 From: Robert Ammon Date: Thu, 11 May 2017 10:42:41 -0700 Subject: [PATCH] wifi: Doxygen fixes --- src/wifi/helper/ht-wifi-mac-helper.h | 4 +--- src/wifi/helper/nqos-wifi-mac-helper.h | 5 ++--- src/wifi/helper/qos-wifi-mac-helper.h | 5 ++--- src/wifi/helper/vht-wifi-mac-helper.h | 5 ++--- src/wifi/helper/wifi-helper.h | 4 ++-- src/wifi/model/interference-helper.h | 2 +- src/wifi/model/simple-frame-capture-model.h | 2 +- src/wifi/model/wifi-mac-queue.h | 2 -- 8 files changed, 11 insertions(+), 18 deletions(-) diff --git a/src/wifi/helper/ht-wifi-mac-helper.h b/src/wifi/helper/ht-wifi-mac-helper.h index 2823f6661..7a5c94ed6 100644 --- a/src/wifi/helper/ht-wifi-mac-helper.h +++ b/src/wifi/helper/ht-wifi-mac-helper.h @@ -27,9 +27,6 @@ #include "qos-wifi-mac-helper.h" #include -/** - * (Deprecated) ns3::HtWifiMacHelper declaration. - */ namespace ns3 { @@ -38,6 +35,7 @@ namespace ns3 { * * This class can create MACs of type ns3::ApWifiMac, ns3::StaWifiMac, * and, ns3::AdhocWifiMac, with QosSupported and HTSupported attributes set to True. + * \deprecated This class deprecated and replaced by ns3::WifiMacHelper */ class HtWifiMacHelper : public QosWifiMacHelper { diff --git a/src/wifi/helper/nqos-wifi-mac-helper.h b/src/wifi/helper/nqos-wifi-mac-helper.h index 3b4c11651..71044a53a 100644 --- a/src/wifi/helper/nqos-wifi-mac-helper.h +++ b/src/wifi/helper/nqos-wifi-mac-helper.h @@ -23,9 +23,6 @@ #include "wifi-helper.h" -/** - * (Deprecated) ns3::NonQosWifiMacHelper declaration. - */ namespace ns3 { @@ -34,6 +31,8 @@ namespace ns3 { * * This class can create MACs of type ns3::ApWifiMac, ns3::StaWifiMac, * and, ns3::AdhocWifiMac, with QosSupported attribute set to False. + * + * \deprecated This class deprecated and replaced by ns3::WifiMacHelper */ class NqosWifiMacHelper : public WifiMacHelper { diff --git a/src/wifi/helper/qos-wifi-mac-helper.h b/src/wifi/helper/qos-wifi-mac-helper.h index b4750d275..bf61b42ae 100644 --- a/src/wifi/helper/qos-wifi-mac-helper.h +++ b/src/wifi/helper/qos-wifi-mac-helper.h @@ -26,9 +26,6 @@ #include -/** - * (Deprecated) ns3::QosWifiMacHelper declaration. - */ namespace ns3 { @@ -37,6 +34,8 @@ namespace ns3 { * * This class can create MACs of type ns3::ApWifiMac, ns3::StaWifiMac, * and, ns3::AdhocWifiMac, with QosSupported attribute set to True. + * + * \deprecated This class deprecated and replaced by ns3::WifiMacHelper */ class QosWifiMacHelper : public WifiMacHelper { diff --git a/src/wifi/helper/vht-wifi-mac-helper.h b/src/wifi/helper/vht-wifi-mac-helper.h index 59a365ca7..b6a5b955d 100644 --- a/src/wifi/helper/vht-wifi-mac-helper.h +++ b/src/wifi/helper/vht-wifi-mac-helper.h @@ -27,9 +27,6 @@ #include "qos-wifi-mac-helper.h" #include -/** - * (Deprecated) ns3::VhtWifiMacHelper declaration. - */ namespace ns3 { @@ -38,6 +35,8 @@ namespace ns3 { * * This class can create MACs of type ns3::ApWifiMac, ns3::StaWifiMac, * and, ns3::AdhocWifiMac, with QosSupported, HTSupported and VHTSupported attributes set to True + * + * \deprecated This class deprecated and replaced by ns3::WifiMacHelper */ class VhtWifiMacHelper : public QosWifiMacHelper { diff --git a/src/wifi/helper/wifi-helper.h b/src/wifi/helper/wifi-helper.h index 74f88df9b..1e672dd7e 100644 --- a/src/wifi/helper/wifi-helper.h +++ b/src/wifi/helper/wifi-helper.h @@ -277,8 +277,8 @@ public: * \returns a device container which contains all the devices created by this method. */ NetDeviceContainer - virtual Install (const WifiPhyHelper &phyHelper, - const WifiMacHelper &macHelper, + virtual Install (const WifiPhyHelper &phy, + const WifiMacHelper &mac, NodeContainer::Iterator first, NodeContainer::Iterator last) const; /** diff --git a/src/wifi/model/interference-helper.h b/src/wifi/model/interference-helper.h index bec3b1407..319f0e267 100644 --- a/src/wifi/model/interference-helper.h +++ b/src/wifi/model/interference-helper.h @@ -253,7 +253,7 @@ public: private: Time m_time; ///< time double m_delta; ///< delta - Ptr m_event; + Ptr m_event; ///< event }; /** * typedef for a vector of NiChanges diff --git a/src/wifi/model/simple-frame-capture-model.h b/src/wifi/model/simple-frame-capture-model.h index b3baabac9..d8c0abd9d 100644 --- a/src/wifi/model/simple-frame-capture-model.h +++ b/src/wifi/model/simple-frame-capture-model.h @@ -73,7 +73,7 @@ public: private: - double m_margin; + double m_margin; ///< margin for determining if a new frame }; } //namespace ns3 diff --git a/src/wifi/model/wifi-mac-queue.h b/src/wifi/model/wifi-mac-queue.h index 3fbf8d27e..9815826f7 100644 --- a/src/wifi/model/wifi-mac-queue.h +++ b/src/wifi/model/wifi-mac-queue.h @@ -250,8 +250,6 @@ public: /** * Return first available packet for transmission. The packet is not removed from queue. * - * \param hdr the header of the dequeued packet - * \param tStamp * \param blockedPackets * * \return packet