From 8853f7ee14dfe7d2fb74e1a10ed0f605643e3119 Mon Sep 17 00:00:00 2001 From: Tommaso Pecorella Date: Fri, 7 Jan 2022 23:58:20 -0600 Subject: [PATCH] building: doxygen tweaks --- .../model/buildings-propagation-loss-model.h | 8 ++++---- .../hybrid-buildings-propagation-loss-model.h | 19 +++++++------------ 2 files changed, 11 insertions(+), 16 deletions(-) diff --git a/src/buildings/model/buildings-propagation-loss-model.h b/src/buildings/model/buildings-propagation-loss-model.h index 2242700f6..dad200831 100644 --- a/src/buildings/model/buildings-propagation-loss-model.h +++ b/src/buildings/model/buildings-propagation-loss-model.h @@ -137,18 +137,18 @@ protected: /// Map of the shadowng loss mutable std::map, std::map, ShadowingLoss> > m_shadowingLossMap; /** - * Caluculate the Standard deviation of the normal distribution used for calculate the shadowing + * Calculate the Standard deviation of the normal distribution used to calculate the shadowing * \param a Room A data * \param b Room B data * \return the Standard deviation of the normal distribution */ double EvaluateSigma (Ptr a, Ptr b) const; - /// Standard deviation of the normal distribution used for calculate the shadowing due to ext walls + /// Standard deviation of the normal distribution used to calculate the shadowing due to ext walls double m_shadowingSigmaExtWalls; - /// Standard deviation of the normal distribution used for calculate the shadowing for outdoor nodes + /// Standard deviation of the normal distribution used to calculate the shadowing for outdoor nodes double m_shadowingSigmaOutdoor; - /// Standard deviation of the normal distribution used for calculate the shadowing for indoor nodes + /// Standard deviation of the normal distribution used to calculate the shadowing for indoor nodes double m_shadowingSigmaIndoor; Ptr m_randVariable; //!< Random variable diff --git a/src/buildings/model/hybrid-buildings-propagation-loss-model.h b/src/buildings/model/hybrid-buildings-propagation-loss-model.h index ac9a2c8eb..86fc3eef5 100644 --- a/src/buildings/model/hybrid-buildings-propagation-loss-model.h +++ b/src/buildings/model/hybrid-buildings-propagation-loss-model.h @@ -107,31 +107,26 @@ public: private: /** - * Compute the path loss using either OkumuraHataPropagationLossModel - * or Kun2600MhzPropagationLossModel - * + * @{ * \param a the mobility model of the source * \param b the mobility model of the destination * \returns the propagation loss (in dBm) */ + /** + * Compute the path loss using either OkumuraHataPropagationLossModel + * or Kun2600MhzPropagationLossModel + */ double OkumuraHata (Ptr a, Ptr b) const; /** - * Compute the path loss using either ItuR1411LosPropagationLossModelor + * Compute the path loss using either ItuR1411LosPropagationLossModel or * ItuR1411NlosOverRooftopPropagationLossModel - * - * \param a the mobility model of the source - * \param b the mobility model of the destination - * \returns the propagation loss (in dBm) */ double ItuR1411 (Ptr a, Ptr b) const; /** * Compute the path loss using ItuR1238PropagationLossModel - * - * \param a the mobility model of the source - * \param b the mobility model of the destination - * \returns the propagation loss (in dBm) */ double ItuR1238 (Ptr a, Ptr b) const; + /** @} */ /// OkumuraHataPropagationLossModel Ptr m_okumuraHata;