lte: Improve doxygen

src/lte/helper/radio-bearer-stats-connector.h

@@ -272,8 +272,8 @@ private:
    */
   struct CellIdRnti
   {
-    uint16_t cellId; //!< cellId
-    uint16_t rnti; //!< rnti
+    uint16_t cellId; //!< Cell Id
+    uint16_t rnti; //!< RNTI
   };
 
   /**

src/lte/model/ff-mac-common.h

@@ -93,24 +93,24 @@ enum NormalExtended_e
 struct DlDciListElement_s
 {
   uint16_t  m_rnti; ///< RNTI
-  uint32_t  m_rbBitmap; ///< rb bitmap
-  uint8_t   m_rbShift; ///< rb shift
-  uint8_t   m_resAlloc; ///< res allocate
-  std::vector <uint16_t>  m_tbsSize; ///< tbs size
-  std::vector <uint8_t>   m_mcs; ///< mcs
-  std::vector <uint8_t>   m_ndi; ///< ndi
-  std::vector <uint8_t>   m_rv; ///< rv
-  uint8_t   m_cceIndex; ///< CCE index
-  uint8_t   m_aggrLevel; ///< aggr level
+  uint32_t  m_rbBitmap; ///< RB bitmap
+  uint8_t   m_rbShift; ///< RB shift
+  uint8_t   m_resAlloc; ///< The type of resource allocation
+  std::vector <uint16_t>  m_tbsSize; ///< The TBs size
+  std::vector <uint8_t>   m_mcs; ///< MCS
+  std::vector <uint8_t>   m_ndi; ///< New data indicator
+  std::vector <uint8_t>   m_rv; ///< Redundancy version
+  uint8_t   m_cceIndex; ///< Control Channel Element index
+  uint8_t   m_aggrLevel; ///< The aggregation level
   uint8_t   m_precodingInfo; ///< precoding info
   /// Format enumeration
   enum Format_e
   {
     ONE, ONE_A, ONE_B, ONE_C, ONE_D, TWO, TWO_A, TWO_B
   } m_format; ///< the format
-  uint8_t   m_tpc; ///< TPC
+  uint8_t   m_tpc; ///< Tx power control command
   uint8_t   m_harqProcess; ///< HARQ process
-  uint8_t   m_dai; ///< DAI
+  uint8_t   m_dai; ///< DL assignment index
   /// Vrb Format enum
   enum VrbFormat_e
   {
@@ -144,15 +144,15 @@ struct UlDciListElement_s
   uint16_t  m_tbSize; ///< size
   uint8_t   m_mcs; ///< MCS
   uint8_t   m_ndi; ///< NDI
-  uint8_t   m_cceIndex; ///< CCE index
-  uint8_t   m_aggrLevel; ///< aggr level
+  uint8_t   m_cceIndex; ///< Control Channel Element index
+  uint8_t   m_aggrLevel; ///< The aggregation level
   uint8_t   m_ueTxAntennaSelection; ///< UE antenna selection
   bool      m_hopping; ///< hopping?
   uint8_t   m_n2Dmrs; ///< n2 DMRS
-  int8_t    m_tpc; ///< TPC
+  int8_t    m_tpc; ///< Tx power control command
   bool      m_cqiRequest; ///< CQI request
   uint8_t   m_ulIndex; ///< UL index
-  uint8_t   m_dai; ///< DAI
+  uint8_t   m_dai; ///< DL assignment index
   uint8_t   m_freqHopping; ///< freq hopping
   int8_t    m_pdcchPowerOffset; ///< CCH power offset
 };
@@ -183,7 +183,7 @@ struct VendorSpecificListElement_s
  */
 struct LogicalChannelConfigListElement_s
 {
-  uint8_t   m_logicalChannelIdentity; ///< logical channel indentity
+  uint8_t   m_logicalChannelIdentity; ///< logical channel identity
   uint8_t   m_logicalChannelGroup; ///< logical channel group
 
   /// Direction enum
@@ -203,7 +203,7 @@ struct LogicalChannelConfigListElement_s
 
   uint8_t   m_qci; ///< QCI
   uint64_t  m_eRabMaximulBitrateUl; ///< ERAB maximum bit rate UL
-  uint64_t  m_eRabMaximulBitrateDl; ///< ERAB mqximum bit rate DL
+  uint64_t  m_eRabMaximulBitrateDl; ///< ERAB maximum bit rate DL
   uint64_t  m_eRabGuaranteedBitrateUl; ///< ERAB guaranteed bit rate UL
   uint64_t  m_eRabGuaranteedBitrateDl; ///< ERAB guaranteed bit rate DL
 };
@@ -237,7 +237,7 @@ struct PhichListElement_s
  */
 struct RlcPduListElement_s
 {
-  uint8_t   m_logicalChannelIdentity; ///< logical channel indentity
+  uint8_t   m_logicalChannelIdentity; ///< logical channel identity
   uint16_t  m_size; ///< size
 };
 
@@ -264,7 +264,7 @@ struct UlGrant_s
   uint16_t m_tbSize; ///< size
   uint8_t m_mcs; ///< MCS
   bool m_hopping; ///< hopping?
-  int8_t m_tpc; ///< TPC 
+  int8_t m_tpc; ///< Tx power control command
   bool m_cqiRequest; ///< CQI request?
   bool m_ulDelay; ///< UL delay?
 }; 
@@ -306,7 +306,7 @@ struct UlInfoListElement_s
   {
     Ok, NotOk, NotValid
   } m_receptionStatus; ///< the status
-  uint8_t   m_tpc; ///< TPC
+  uint8_t   m_tpc; ///< Tx power control command
 };
 
 /**

src/lte/model/lte-amc.h

@@ -71,13 +71,13 @@ public:
    * \brief Get the Modulation and Coding Scheme for
    * a CQI value
    * \param cqi the cqi value
-   * \return the MCS  value
+   * \return the MCS value
    */
   int GetMcsFromCqi (int cqi);
 
   /**
   * \brief Get the Transport Block Size for a selected MCS and number of PRB (table 7.1.7.2.1-1 of 36.213)
-  * \param mcs the mcs index
+  * \param mcs the MCS index
   * \param nprb the no. of PRB
   * \return the Transport Block Size in bits
   */
@@ -85,7 +85,7 @@ public:
 
   /**
    * \brief Get the Transport Block Size for a selected MCS and number of PRB (table 8.6.1-1 of 36.213)
-   * \param mcs the mcs index
+   * \param mcs the MCS index
    * \param nprb the no. of PRB
    * \return the Transport Block Size in bits
    */

src/lte/model/lte-enb-mac.h

@@ -363,7 +363,7 @@ private:
   */
   void DoDlInfoListElementHarqFeeback (DlInfoListElement_s params);
 
-  /// rnti, lcid, SAP of the RLC instance
+  /// RNTI, LC ID, SAP of the RLC instance
   std::map <uint16_t, std::map<uint8_t, LteMacSapUser*> > m_rlcAttached;
 
   std::vector <CqiListElement_s> m_dlCqiReceived; ///< DL-CQI received

src/lte/model/lte-ffr-distributed-algorithm.h

@@ -174,9 +174,9 @@ private:
     uint8_t m_rsrq; ///< RSRQ
   };
 
-  ///               cellId
+  /// Cell Id is used as the key for the following map
   typedef std::map<uint16_t, Ptr<UeMeasure> > MeasurementRow_t;
-  ///               rnti
+  /// RNTI is used as the key for the following map
   typedef std::map<uint16_t, MeasurementRow_t> MeasurementTable_t;
   MeasurementTable_t m_ueMeasures; ///< UE measures
 

src/lte/model/lte-harq-phy.h

@@ -39,8 +39,8 @@ namespace ns3 {
 /// HarqProcessInfoElement_t structure
 struct HarqProcessInfoElement_t
 {
-   double m_mi; ///< MI
-   uint8_t m_rv; ///< RV
+   double m_mi; ///< Mutual information
+   uint8_t m_rv; ///< Redundancy version
    uint16_t m_infoBits; ///< info bits
    uint16_t m_codeBits; ///< code bits
 };

src/lte/model/lte-mi-error-model.h

@@ -69,8 +69,8 @@ namespace ns3 {
 /// TbStats_t structure
 struct TbStats_t
 {
-  double tbler; ///< tbler
-  double mi; ///< mi
+  double tbler; ///< Transport block BLER
+  double mi; ///< Mutual information
 };
   
 
@@ -85,8 +85,8 @@ public:
 
   /** 
    * \brief find the mmib (mean mutual information per bit) for different modulations of the specified TB
-   * \param sinr the perceived sinrs in the whole bandwidth
-   * \param map the actives RBs for the TB
+   * \param sinr the perceived sinr values in the whole bandwidth in Watt
+   * \param map the active RBs for the TB
    * \param mcs the MCS of the TB
    * \return the mmib
    */
@@ -102,18 +102,18 @@ public:
 
   /**
    * \brief run the error-model algorithm for the specified TB
-   * \param sinr the perceived sinrs in the whole bandwidth
-   * \param map the actives RBs for the TB
+   * \param sinr the perceived sinr values in the whole bandwidth in Watt
+   * \param map the active RBs for the TB
    * \param size the size in bytes of the TB
    * \param mcs the MCS of the TB
-   * \param miHistory  MI of past transmissions (in case of retx)
+   * \param miHistory MI of past transmissions (in case of retx)
    * \return the TB error rate and MI
    */
   static TbStats_t GetTbDecodificationStats (const SpectrumValue& sinr, const std::vector<int>& map, uint16_t size, uint8_t mcs, HarqProcessInfoList_t miHistory);
   
   /** 
   * \brief run the error-model algorithm for the specified PCFICH+PDCCH channels
-  * \param sinr the perceived sinrs in the whole bandwidth
+  * \param sinr the perceived sinr values in the whole bandwidth in Watt
   * \return the decodification error of the PCFICH+PDCCH channels
   */  
   static double GetPcfichPdcchError (const SpectrumValue& sinr);

src/lte/model/lte-spectrum-phy.h

@@ -55,8 +55,8 @@ struct TbId_t
   /**
    * Constructor
    *
-   * \param a rnti
-   * \param b layer
+   * \param a RNTI
+   * \param b Layer
    */
   TbId_t (const uint16_t a, const uint8_t b);
   
@@ -68,13 +68,13 @@ struct TbId_t
 /// tbInfo_t structure
 struct tbInfo_t
 {
-  uint8_t ndi; ///< ndi
-  uint16_t size; ///< size
-  uint8_t mcs; ///< mcs
-  std::vector<int> rbBitmap; ///< rb bitmap
+  uint8_t ndi; ///< New data indicator
+  uint16_t size; ///< Transport block size
+  uint8_t mcs; ///< MCS
+  std::vector<int> rbBitmap; ///< Resource block bitmap
   uint8_t harqProcessId; ///< HARQ process id
-  uint8_t rv; ///< rv
-  double mi; ///< mi
+  uint8_t rv; ///< Redundancy version
+  double mi; ///< Mutual information
   bool downlink; ///< whether is downlink
   bool corrupt; ///< whether is corrupt
   bool harqFeedbackSent; ///< is HARQ feedback sent
@@ -389,14 +389,14 @@ public:
   /** 
   * 
   * 
-  * \param rnti the rnti of the source of the TB
+  * \param rnti the RNTI of the source of the TB
   * \param ndi new data indicator flag
   * \param size the size of the TB
   * \param mcs the MCS of the TB
   * \param map the map of RB(s) used
   * \param layer the layer (in case of MIMO tx)
   * \param harqId the id of the HARQ process (valid only for DL)
-  * \param rv the rv
+  * \param rv the redundancy version
   * \param downlink true when the TB is for DL
   */
   void AddExpectedTb (uint16_t  rnti, uint8_t ndi, uint16_t size, uint8_t mcs, std::vector<int> map, uint8_t layer, uint8_t harqId, uint8_t rv, bool downlink);

src/lte/model/lte-ue-phy-sap.h

@@ -57,7 +57,7 @@ public:
    * send a preamble on the PRACH
    * 
    * \param prachId the ID of the preamble
-   * \param raRnti the RA rnti
+   * \param raRnti the RA RNTI
    */
   virtual void SendRachPreamble (uint32_t prachId, uint32_t raRnti) = 0;
 

src/lte/model/lte-ue-phy.h

@@ -577,7 +577,7 @@ private:
   Ptr<LteHarqPhy> m_harqPhyModule; ///< HARQ phy module
 
   uint32_t m_raPreambleId; ///< RA preamble ID
-  uint32_t m_raRnti; ///< RA rnti
+  uint32_t m_raRnti; ///< RA RNTI
 
   /**
    * The `ReportCurrentCellRsrpSinr` trace source. Trace information regarding