From 48967b3ffe189ba7bd0a0e47fdfdba85ca2389c7 Mon Sep 17 00:00:00 2001 From: Nicola Baldo Date: Mon, 23 Jul 2012 19:06:32 +0200 Subject: [PATCH] updated doxygen of Get/SetDownlinkSubChannels to reflect actual usage --- src/lte/model/lte-enb-phy.h | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/lte/model/lte-enb-phy.h b/src/lte/model/lte-enb-phy.h index 1ce50e585..e84a5be09 100644 --- a/src/lte/model/lte-enb-phy.h +++ b/src/lte/model/lte-enb-phy.h @@ -121,18 +121,20 @@ public: /** * \brief set the resource blocks (a.k.a. sub channels) to be used in the downlink for transmission * - * \param mask a bitmask implemented as a vector. If the i-th value - * of mask is equal to 1 (0) it means that the i-th resource block - * is used (not used) for transmission in the downlink. + * \param mask a vector of integers, if the i-th value is j it means + * that the j-th resource block is used for transmission in the + * downlink. If there is no i such that the value of the i-th + * element is j, it means that RB j is not used. */ void SetDownlinkSubChannels (std::vector mask ); /** * - * \return a bitmask implemented as a vector. If the i-th value - * of mask is equal to 1 (0) it means that the i-th resource block - * is used (not used) for transmission in the downlink. + * \return a vector of integers, if the i-th value is j it means + * that the j-th resource block is used for transmission in the + * downlink. If there is no i such that the value of the i-th + * element is j, it means that RB j is not used. */ std::vector GetDownlinkSubChannels (void);