wifi: document InterferenceHelper::CalculateSnr parameters
authorAlexander Krotov <krotov@iitp.ru>
Wed, 05 Dec 2018 01:16:07 +0300
changeset 13888 231e5749e563
parent 13887 7b4629f45e51
child 13889 207a8e737d20
wifi: document InterferenceHelper::CalculateSnr parameters
src/wifi/model/interference-helper.h
--- a/src/wifi/model/interference-helper.h	Wed Dec 05 01:14:38 2018 +0300
+++ b/src/wifi/model/interference-helper.h	Wed Dec 05 01:16:07 2018 +0300
@@ -266,9 +266,9 @@
   /**
    * Calculate SNR (linear ratio) from the given signal power and noise+interference power.
    *
-   * \param signal
-   * \param noiseInterference
-   * \param channelWidth
+   * \param signal signal power, W
+   * \param noiseInterference noise and interference power, W
+   * \param channelWidth signal width in MHz
    *
    * \return SNR in linear ratio
    */