From fe7e8fb07a54710383cfd98ce3c58afbb1717038 Mon Sep 17 00:00:00 2001 From: Robert Ammon Date: Fri, 21 Apr 2017 21:10:48 -0700 Subject: [PATCH] spectrum: correct Doxygen warnings --- .../model/wifi-spectrum-value-helper.cc | 20 +++++++++++++++---- .../model/wifi-spectrum-value-helper.h | 14 ++++++++++--- 2 files changed, 27 insertions(+), 7 deletions(-) diff --git a/src/spectrum/model/wifi-spectrum-value-helper.cc b/src/spectrum/model/wifi-spectrum-value-helper.cc index 836236735..a8686558c 100644 --- a/src/spectrum/model/wifi-spectrum-value-helper.cc +++ b/src/spectrum/model/wifi-spectrum-value-helper.cc @@ -31,11 +31,17 @@ namespace ns3 { NS_LOG_COMPONENT_DEFINE ("WifiSpectrumValueHelper"); +///< Wifi Spectrum Model structure struct WifiSpectrumModelId { + /** + * Constructor + * \param f the frequency in Mhz + * \param w the channel width in Mhz + */ WifiSpectrumModelId (uint32_t f, uint8_t w); - uint32_t m_centerFrequency; - uint8_t m_channelWidth; + uint32_t m_centerFrequency; ///< center frequency + uint8_t m_channelWidth; ///< channel width }; WifiSpectrumModelId::WifiSpectrumModelId (uint32_t f, uint8_t w) @@ -45,13 +51,19 @@ WifiSpectrumModelId::WifiSpectrumModelId (uint32_t f, uint8_t w) NS_LOG_FUNCTION (this << f << (uint16_t)w); } +/** + * Less than operator + * \param a the first wifi spectrum to compare + * \param b the second wifi spectrum to compare + * \returns true if the first spectrum is less than the second spectrum + */ bool operator < (const WifiSpectrumModelId& a, const WifiSpectrumModelId& b) { return ( (a.m_centerFrequency < b.m_centerFrequency) || ( (a.m_centerFrequency == b.m_centerFrequency) && (a.m_channelWidth < b.m_channelWidth))); } -static std::map > g_wifiSpectrumModelMap; +static std::map > g_wifiSpectrumModelMap; ///< static initializer for the class Ptr WifiSpectrumValueHelper::GetSpectrumModel (uint32_t centerFrequency, uint8_t channelWidth, double bandBandwidth, uint8_t guardBandwidth) @@ -554,7 +566,7 @@ WifiSpectrumValueHelper::CreateRfFilter (uint32_t centerFrequency, uint8_t chann return c; } -static Ptr g_WifiSpectrumModel5Mhz; +static Ptr g_WifiSpectrumModel5Mhz; ///< static initializer for the class WifiSpectrumValueHelper::~WifiSpectrumValueHelper () { diff --git a/src/spectrum/model/wifi-spectrum-value-helper.h b/src/spectrum/model/wifi-spectrum-value-helper.h index 41ca4777e..334dc8558 100644 --- a/src/spectrum/model/wifi-spectrum-value-helper.h +++ b/src/spectrum/model/wifi-spectrum-value-helper.h @@ -65,6 +65,7 @@ public: * \param centerFrequency center frequency (MHz) * \param txPowerW transmit power (W) to allocate * \param guardBandwidth width of the guard band (MHz) + * \returns a pointer to a newly allocated SpectrumValue representing the DSSS Transmit Power Spectral Density in W/Hz */ static Ptr CreateDsssTxPowerSpectralDensity (uint32_t centerFrequency, double txPowerW, uint8_t guardBandwidth); @@ -76,6 +77,7 @@ public: * \param channelWidth channel width (MHz) * \param txPowerW transmit power (W) to allocate * \param guardBandwidth width of the guard band (MHz) + * \return a pointer to a newly allocated SpectrumValue representing the OFDM Transmit Power Spectral Density in W/Hz for each Band */ static Ptr CreateOfdmTxPowerSpectralDensity (uint32_t centerFrequency, uint8_t channelWidth, double txPowerW, uint8_t guardBandwidth); @@ -88,6 +90,7 @@ public: * \param channelWidth channel width (MHz) * \param txPowerW transmit power (W) to allocate * \param guardBandwidth width of the guard band (MHz) + * \return a pointer to a newly allocated SpectrumValue representing the HT OFDM Transmit Power Spectral Density in W/Hz for each Band */ static Ptr CreateHtOfdmTxPowerSpectralDensity (uint32_t centerFrequency, uint8_t channelWidth, double txPowerW, uint8_t guardBandwidth); @@ -100,29 +103,34 @@ public: * \param channelWidth channel width (MHz) * \param txPowerW transmit power (W) to allocate * \param guardBandwidth width of the guard band (MHz) + * \return a pointer to a newly allocated SpectrumValue representing the HE OFDM Transmit Power Spectral Density in W/Hz for each Band */ static Ptr CreateHeOfdmTxPowerSpectralDensity (uint32_t centerFrequency, uint8_t channelWidth, double txPowerW, uint8_t guardBandwidth); /** + * Create a power spectral density corresponding to the noise * * \param centerFrequency center frequency (MHz) * \param channelWidth channel width (MHz) * \param bandBandwidth width of each band (Hz) * \param noiseFigure the noise figure in dB w.r.t. a reference temperature of 290K * \param guardBandwidth width of the guard band (MHz) - * * \return a pointer to a newly allocated SpectrumValue representing the noise Power Spectral Density in W/Hz for each Band */ static Ptr CreateNoisePowerSpectralDensity (uint32_t centerFrequency, uint8_t channelWidth, double bandBandwidth, double noiseFigure, uint8_t guardBandwidth); /** - * \param centerFrequency center frequency (MHz) - * \param channelWidth channel width (MHz) + * Create a thermal noise power spectral density + * + * \param noiseFigure the noise figure + * \param spectrumModel the spectrum model * \return a pointer to a newly allocated SpectrumValue representing the noise Power Spectral Density in W/Hz corresponding to thermal noise, for each Band */ static Ptr CreateNoisePowerSpectralDensity (double noiseFigure, Ptr spectrumModel); /** + * Create a spectral density corresponding to the RF filter + * * \param centerFrequency center frequency (MHz) * \param channelWidth channel width (MHz) * \param bandBandwidth width of each band (Hz)