lte: Additional doxygen corrections (patch set 5)

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

@@ -77,6 +77,7 @@ public:
 
   /**
     * Class constructor
+    * \param protocolType the name of the protocol type
     */
   RadioBearerStatsCalculator (std::string protocolType);
 

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

@@ -58,11 +58,11 @@ public:
 
 /**
  * Callback function for DL TX statistics for both RLC and PDCP
- * /param arg
- * /param path
- * /param rnti
- * /param lcid
- * /param packetSize
+ * \param arg
+ * \param path
+ * \param rnti
+ * \param lcid
+ * \param packetSize
  */
 void
 DlTxPduCallback (Ptr<BoundCallbackArgument> arg, std::string path,
@@ -74,12 +74,12 @@ DlTxPduCallback (Ptr<BoundCallbackArgument> arg, std::string path,
 
 /**
  * Callback function for DL RX statistics for both RLC and PDCP
- * /param arg
- * /param path
- * /param rnti
- * /param lcid
- * /param packetSize
- * /param delay
+ * \param arg
+ * \param path
+ * \param rnti
+ * \param lcid
+ * \param packetSize
+ * \param delay
  */
 void
 DlRxPduCallback (Ptr<BoundCallbackArgument> arg, std::string path,
@@ -91,11 +91,11 @@ DlRxPduCallback (Ptr<BoundCallbackArgument> arg, std::string path,
 
 /**
  * Callback function for UL TX statistics for both RLC and PDCP
- * /param arg
- * /param path
- * /param rnti
- * /param lcid
- * /param packetSize
+ * \param arg
+ * \param path
+ * \param rnti
+ * \param lcid
+ * \param packetSize
  */
 void
 UlTxPduCallback (Ptr<BoundCallbackArgument> arg, std::string path,
@@ -108,12 +108,12 @@ UlTxPduCallback (Ptr<BoundCallbackArgument> arg, std::string path,
 
 /**
  * Callback function for UL RX statistics for both RLC and PDCP
- * /param arg
- * /param path
- * /param rnti
- * /param lcid
- * /param packetSize
- * /param delay
+ * \param arg
+ * \param path
+ * \param rnti
+ * \param lcid
+ * \param packetSize
+ * \param delay
  */
 void
 UlRxPduCallback (Ptr<BoundCallbackArgument> arg, std::string path,

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

@@ -278,6 +278,10 @@ private:
 
   /**
    * Less than operator for CellIdRnti, because it is used as key in map
+   *
+   * \param a the lhs operand
+   * \param b the rhs operand
+   * \returns true if less than
    */
   friend bool operator < (const CellIdRnti &a, const CellIdRnti &b);
 

src/lte/model/a2-a4-rsrq-handover-algorithm.h

@@ -95,7 +95,7 @@ public:
   virtual void SetLteHandoverManagementSapUser (LteHandoverManagementSapUser* s);
   virtual LteHandoverManagementSapProvider* GetLteHandoverManagementSapProvider ();
 
-  // let the forwarder class access the protected and private members
+  /// let the forwarder class access the protected and private members
   friend class MemberLteHandoverManagementSapProvider<A2A4RsrqHandoverAlgorithm>;
 
 protected:

src/lte/model/a3-rsrp-handover-algorithm.h

@@ -80,7 +80,7 @@ public:
   virtual void SetLteHandoverManagementSapUser (LteHandoverManagementSapUser* s);
   virtual LteHandoverManagementSapProvider* GetLteHandoverManagementSapProvider ();
 
-  // let the forwarder class access the protected and private members
+  /// let the forwarder class access the protected and private members
   friend class MemberLteHandoverManagementSapProvider<A3RsrpHandoverAlgorithm>;
 
 protected:

src/lte/model/component-carrier-enb.h

@@ -80,24 +80,24 @@ public:
   Ptr<FfMacScheduler> GetFfMacScheduler ();
   /**
    * Set the LteEnbPhy
-   * \ param s a pointer to the LteEnbPhy
+   * \param s a pointer to the LteEnbPhy
    */
   void SetPhy (Ptr<LteEnbPhy> s);
   /**
    * Set the LteEnbMac
-   * \ param s a pointer to the LteEnbMac
+   * \param s a pointer to the LteEnbMac
    */
   void SetMac (Ptr<LteEnbMac> s);
 
   /**
    * Set the FfMacScheduler Algorithm
-   * \ param s a pointer to the FfMacScheduler
+   * \param s a pointer to the FfMacScheduler
    */
   void SetFfMacScheduler (Ptr<FfMacScheduler> s);
 
   /**
    * Set the LteFfrAlgorithm
-   * \ param s a pointer to the LteFfrAlgorithm
+   * \param s a pointer to the LteFfrAlgorithm
    */
   void SetFfrAlgorithm (Ptr<LteFfrAlgorithm> s);
   

src/lte/model/component-carrier-ue.h

@@ -70,7 +70,7 @@ public:
 
   /**
    * Set the LteEnbMac
-   * \ param s a pointer to the LteEnbMac
+   * \param s a pointer to the LteEnbMac
    */ 
   void SetMac (Ptr<LteUeMac> s);
   

src/lte/model/cqa-ff-mac-scheduler.h

@@ -111,7 +111,9 @@ public:
   virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
   virtual LteFfrSapUser* GetLteFfrSapUser ();
 
+  /// allow MemberCschedSapProvider<CqaFfMacScheduler> class friend access
   friend class MemberCschedSapProvider<CqaFfMacScheduler>;
+  /// allow MemberSchedSapProvider<CqaFfMacScheduler> class friend access
   friend class MemberSchedSapProvider<CqaFfMacScheduler>;
 
   /**

src/lte/model/epc-enb-application.h

@@ -49,7 +49,9 @@ class EpcEnbS1SapProvider;
 class EpcEnbApplication : public Application
 {
 
+  /// allow MemberEpcEnbS1SapProvider<EpcEnbApplication> class friend access
   friend class MemberEpcEnbS1SapProvider<EpcEnbApplication>;
+  /// allow MemberEpcS1apSapEnb<EpcEnbApplication> class friend access
   friend class MemberEpcS1apSapEnb<EpcEnbApplication>;
 
 

src/lte/model/epc-mme.h

@@ -40,7 +40,9 @@ class NetDevice;
 class EpcMme : public Object
 {
 
+  /// allow MemberEpcS1apSapMme<EpcMme> class friend access
   friend class MemberEpcS1apSapMme<EpcMme>;
+  /// allow MemberEpcS11SapMme<EpcMme> class friend access
   friend class MemberEpcS11SapMme<EpcMme>;
   
 public:

src/lte/model/epc-s11-sap.h

@@ -210,6 +210,7 @@ public:
 
   /**
     * \brief As per 3GPP TS 29.274 Release 9 V9.3.0, a Delete Bearer Command message shall be sent on the S11 interface by the MME to the SGW
+    * \param msg the DeleteBearerCommandMessage
     */
   virtual void DeleteBearerCommand (DeleteBearerCommandMessage msg) = 0;
 

src/lte/model/epc-sgw-pgw-application.h

@@ -47,6 +47,7 @@ namespace ns3 {
  */
 class EpcSgwPgwApplication : public Application
 {
+  /// allow MemberEpcS11SapSgw<EpcSgwPgwApplication> class friend access
   friend class MemberEpcS11SapSgw<EpcSgwPgwApplication>;
 
 public:

src/lte/model/epc-ue-nas.h

@@ -33,6 +33,7 @@ class EpcHelper;
 
 class EpcUeNas : public Object
 {
+  /// allow MemberLteAsSapUser<EpcUeNas> class friend access
   friend class MemberLteAsSapUser<EpcUeNas>;
 public:
 

src/lte/model/epc-x2.h

@@ -98,6 +98,7 @@ public:
  */
 class EpcX2 : public Object
 {
+  /// allow EpcX2SpecificEpcX2SapProvider<EpcX2> class friend access
   friend class EpcX2SpecificEpcX2SapProvider<EpcX2>;
 
 public:

src/lte/model/eps-bearer-tag.h

@@ -50,6 +50,9 @@ public:
 
   /**
    * Create a EpsBearerTag with the given RNTI and bearer id
+   *
+   * @param rnti the value of the RNTI to set
+   * @param bid the value of the Bearer Id to set
    */
   EpsBearerTag (uint16_t  rnti, uint8_t bid);
   
@@ -63,7 +66,7 @@ public:
   /**
    * Set the bearer id to the given value.
    *
-   * @param bid the value of the RNTI to set
+   * @param bid the value of the Bearer Id to set
    */
   void SetBid (uint8_t bid);
 
@@ -78,14 +81,14 @@ public:
    */
   uint16_t GetRnti (void) const;
   /**
-   * Get bid function
-   * \returns the bid
+   * Get Bearer Id function
+   * \returns the Bearer Id
    */
   uint8_t GetBid (void) const;
 
 private:
   uint16_t m_rnti; ///< RNTI value
-  uint8_t m_bid; ///< bid value
+  uint8_t m_bid; ///< Bearer Id value
 
 };
 

src/lte/model/fdbet-ff-mac-scheduler.h

@@ -103,7 +103,9 @@ public:
   virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
   virtual LteFfrSapUser* GetLteFfrSapUser ();
 
+  /// allow MemberCschedSapProvider<FdBetFfMacScheduler> class friend access
   friend class MemberCschedSapProvider<FdBetFfMacScheduler>;
+  /// allow MemberSchedSapProvider<FdBetFfMacScheduler> class friend access
   friend class MemberSchedSapProvider<FdBetFfMacScheduler>;
 
   /**

src/lte/model/fdmt-ff-mac-scheduler.h

@@ -98,7 +98,9 @@ public:
   virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
   virtual LteFfrSapUser* GetLteFfrSapUser ();
 
+  /// allow MemberCschedSapProvider<FdMtFfMacScheduler> class friend access
   friend class MemberCschedSapProvider<FdMtFfMacScheduler>;
+  /// allow MemberSchedSapProvider<FdMtFfMacScheduler> clss friend access
   friend class MemberSchedSapProvider<FdMtFfMacScheduler>;
 
   /**

src/lte/model/fdtbfq-ff-mac-scheduler.h

@@ -137,7 +137,9 @@ public:
    */
   virtual LteFfrSapUser* GetLteFfrSapUser ();
 
+  /// allow MemberCschedSapProvider<FdTbfqFfMacScheduler> class friend access
   friend class MemberCschedSapProvider<FdTbfqFfMacScheduler>;
+  /// allow MemberSchedSapProvider<FdTbfqFfMacScheduler> claass friend access
   friend class MemberSchedSapProvider<FdTbfqFfMacScheduler>;
 
   /**

src/lte/model/lte-anr.h

@@ -135,7 +135,7 @@ public:
    */
   virtual LteAnrSapProvider* GetLteAnrSapProvider ();
 
-  // let the forwarder class access the protected and private members
+  /// let the forwarder class access the protected and private members
   friend class MemberLteAnrSapProvider<LteAnr>;
 
 protected:
@@ -220,7 +220,11 @@ private:
   /// neighbor relation table
   NeighbourRelationTable_t m_neighbourRelationTable; 
 
-  /// internal methods
+  /**
+   * \internal methods
+   * \param cellId
+   * \returns the neighbor relation
+   */
   const NeighbourRelation_t* Find (uint16_t cellId) const;
 
   /// The expected measurement identity

src/lte/model/lte-ccm-rrc-sap.h

@@ -46,7 +46,9 @@ namespace ns3 {
 class LteCcmRrcSapProvider
 {
 
+/// allow UeManager class friend access
 friend class UeManager;
+/// allow LteMacSapUser class friend access
 friend class LteMacSapUser;
  
 public:
@@ -148,6 +150,7 @@ public:
  */
 class LteCcmRrcSapUser
 {
+  /// allow LteEnbRrc class friend access
   friend class LteEnbRrc;
 public:
   virtual ~LteCcmRrcSapUser ();

src/lte/model/lte-common.h

@@ -173,7 +173,11 @@ public:
 class TransmissionModesLayers
 {
 public:
-  /// Transmit mode 2 layer number
+  /**
+   * Transmit mode 2 layer number
+   * \param txMode the transmit mode
+   * \returns the layer 2 number
+   */
   static uint8_t TxMode2LayerNum (uint8_t txMode);
 };
 

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

@@ -54,11 +54,17 @@ typedef std::vector <std::vector < Ptr<PacketBurst> > > DlHarqProcessesBuffer_t;
  */
 class LteEnbMac :   public Object
 {
+  /// allow EnbMacMemberLteEnbCmacSapProvider class friend access
   friend class EnbMacMemberLteEnbCmacSapProvider;
+  /// allow EnbMacMemberLteMacSapProvider<LteEnbMac> class friend access
   friend class EnbMacMemberLteMacSapProvider<LteEnbMac>;
+  /// allow EnbMacMemberFfMacSchedSapUser class friend access
   friend class EnbMacMemberFfMacSchedSapUser;
+  /// allow EnbMacMemberFfMacCschedSapUser class friend access
   friend class EnbMacMemberFfMacCschedSapUser;
+  /// allow EnbMacMemberLteEnbPhySapUser class friend access
   friend class EnbMacMemberLteEnbPhySapUser;
+  /// allow MemberLteCcmMacSapProvider<LteEnbMac> class friend ccess
   friend class MemberLteCcmMacSapProvider<LteEnbMac>;
 
 public:

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

@@ -46,7 +46,9 @@ class LteUePhy;
  */
 class LteEnbPhy : public LtePhy
 {
+  /// allow EnbMemberLteEnbPhySapProvider class friend access
   friend class EnbMemberLteEnbPhySapProvider;
+  /// allow MemberLteEnbCphySapProvider<LteEnbPhy> class friend access
   friend class MemberLteEnbCphySapProvider<LteEnbPhy>;
 
 public:
@@ -185,11 +187,13 @@ public:
 
   /**
    * \brief Create the PSD for TX
+   * \returns the PSD
    */
   virtual Ptr<SpectrumValue> CreateTxPowerSpectralDensity ();
 
   /**
    * \brief Create the PSD for TX with power allocation for each RB
+   * \return the PSD
    */
   virtual Ptr<SpectrumValue> CreateTxPowerSpectralDensityWithPowerAllocation ();
 
@@ -264,6 +268,7 @@ public:
 
   /**
    * \brief PhySpectrum received a new PHY-PDU
+   * \param p the packet received
    */
   void PhyPduReceived (Ptr<Packet> p);
 

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

@@ -71,6 +71,7 @@ class Packet;
  */
 class UeManager : public Object
 {
+  /// allow LtePdcpSpecificLtePdcpSapUser<UeManager> class friend access
   friend class LtePdcpSpecificLtePdcpSapUser<UeManager>;
 
 public:
@@ -565,14 +566,23 @@ private:
 class LteEnbRrc : public Object
 {
 
+  /// allow EnbRrcMemberLteEnbCmacSapUser class friend access
   friend class EnbRrcMemberLteEnbCmacSapUser;
+  /// allow MemberLteHandoverManagementSapUser<LteEnbRrc> class friend access
   friend class MemberLteHandoverManagementSapUser<LteEnbRrc>;
+  /// allow MemberLteAnrSapUser<LteEnbRrc> class friend access
   friend class MemberLteAnrSapUser<LteEnbRrc>;
+  /// allow MemberLteFfrRrcSapUser<LteEnbRrc> class friend access
   friend class MemberLteFfrRrcSapUser<LteEnbRrc>;
+  /// allow MemberLteEnbRrcSapProvider<LteEnbRrc> class friend access
   friend class MemberLteEnbRrcSapProvider<LteEnbRrc>;
+  /// allow MemberLteEnbRrcSapProvider<LteEnbRrc> class friend access
   friend class MemberEpcEnbS1SapUser<LteEnbRrc>;
+  /// allow MemberEpcEnbS1SapUser<LteEnbRrc> class friend access
   friend class EpcX2SpecificEpcX2SapUser<LteEnbRrc>;
+  /// allow UeManager class friend access
   friend class UeManager;
+  /// allow  MemberLteCcmRrcSapUser<LteEnbRrc> class friend access
   friend class MemberLteCcmRrcSapUser<LteEnbRrc>;
 
 public:
@@ -996,19 +1006,53 @@ private:
 
   // RRC SAP methods
 
-  /// Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::CompleteSetupUe interface to UeManager::CompleteSetupUe
+  /**
+   * Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::CompleteSetupUe interface to UeManager::CompleteSetupUe
+   * \param rnti the RNTI
+   * \param params the LteEnbRrcSapProvider::CompleteSetupUeParameters
+   */
   void DoCompleteSetupUe (uint16_t rnti, LteEnbRrcSapProvider::CompleteSetupUeParameters params);
-  /// Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionRequest interface to UeManager::RecvRrcConnectionRequest
+  /**
+   * Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionRequest interface to UeManager::RecvRrcConnectionRequest
+   *
+   * \param rnti the RNTI
+   * \param msg the LteRrcSap::RrcConnectionRequest
+   */
   void DoRecvRrcConnectionRequest (uint16_t rnti, LteRrcSap::RrcConnectionRequest msg);
-  /// Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionSetupCompleted interface to UeManager::RecvRrcConnectionSetupCompleted
+  /**
+   * Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionSetupCompleted interface to UeManager::RecvRrcConnectionSetupCompleted
+   *
+   * \param rnti the RNTI
+   * \param msg the LteRrcSap::RrcConnectionSetupCompleted
+   */
   void DoRecvRrcConnectionSetupCompleted (uint16_t rnti, LteRrcSap::RrcConnectionSetupCompleted msg);
-  /// Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionReconfigurationCompleted interface to UeManager::RecvRrcConnectionReconfigurationCompleted
+  /**
+   * Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionReconfigurationCompleted interface to UeManager::RecvRrcConnectionReconfigurationCompleted
+   *
+   * \param rnti the RNTI
+   * \param msg the LteRrcSap::RrcConnectionReconfigurationCompleted
+   */
   void DoRecvRrcConnectionReconfigurationCompleted (uint16_t rnti, LteRrcSap::RrcConnectionReconfigurationCompleted msg);
-  /// Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionReestablishmentRequest interface to UeManager::RecvRrcConnectionReestablishmentRequest
+  /**
+   * Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionReestablishmentRequest interface to UeManager::RecvRrcConnectionReestablishmentRequest
+   *
+   * \param rnti the RNTI
+   * \param msg the LteRrcSap::RrcConnectionReestablishmentRequest
+   */
   void DoRecvRrcConnectionReestablishmentRequest (uint16_t rnti, LteRrcSap::RrcConnectionReestablishmentRequest msg);
-  /// Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionReestablishmentComplete interface to UeManager::RecvRrcConnectionReestablishmentComplete
+  /**
+   * Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvRrcConnectionReestablishmentComplete interface to UeManager::RecvRrcConnectionReestablishmentComplete
+   *
+   * \param rnti the RNTI
+   * \param msg the LteRrcSap::RrcConnectionReestablishmentComplete
+   */
   void DoRecvRrcConnectionReestablishmentComplete (uint16_t rnti, LteRrcSap::RrcConnectionReestablishmentComplete msg);
-  /// Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvMeasurementReport interface to UeManager::RecvMeasurementReport
+  /**
+   * Part of the RRC protocol. Forwarding LteEnbRrcSapProvider::RecvMeasurementReport interface to UeManager::RecvMeasurementReport
+   *
+   * \param rnti the RNTI
+   * \param msg the LteRrcSap::MeasurementReport
+   */
   void DoRecvMeasurementReport (uint16_t rnti, LteRrcSap::MeasurementReport msg);
 
   // S1 SAP methods

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

@@ -51,8 +51,9 @@ public:
   virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser* s);
   virtual LteFfrRrcSapProvider* GetLteFfrRrcSapProvider ();
 
-  // let the forwarder class access the protected and private members
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrSapProvider<LteFfrDistributedAlgorithm>;
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrRrcSapProvider<LteFfrDistributedAlgorithm>;
 
 protected:

src/lte/model/lte-ffr-enhanced-algorithm.cc

@@ -88,9 +88,9 @@ static const struct FfrEnhancedUplinkDefaultConfiguration
   { 3, 100, 64, 16, 16}
 }; ///< the enhanced uplink default configuration
 
-/// number of downlink configurations
+/** \returns number of downlink configurations */
 const uint16_t NUM_DOWNLINK_CONFS (sizeof (g_ffrEnhancedDownlinkDefaultConfiguration) / sizeof (FfrEnhancedDownlinkDefaultConfiguration));
-/// number of uplink configurations
+/** \returns number of uplink configurations */
 const uint16_t NUM_UPLINK_CONFS (sizeof (g_ffrEnhancedUplinkDefaultConfiguration) / sizeof (FfrEnhancedUplinkDefaultConfiguration));
 
 

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

@@ -59,8 +59,9 @@ public:
   virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser* s);
   virtual LteFfrRrcSapProvider* GetLteFfrRrcSapProvider ();
 
-  // let the forwarder class access the protected and private members
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrSapProvider<LteFfrEnhancedAlgorithm>;
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrRrcSapProvider<LteFfrEnhancedAlgorithm>;
 
 protected:

src/lte/model/lte-ffr-rrc-sap.h

@@ -71,6 +71,7 @@ public:
 
   /**
    * \brief RecvLoadInformation
+   * \param params the EpcX2Sap::LoadInformationParams
    */
   virtual void  RecvLoadInformation (EpcX2Sap::LoadInformationParams params) = 0;
 
@@ -126,6 +127,7 @@ public:
 
   /**
    * \brief SendLoadInformation
+   * \param params the EpcX2Sap::LoadInformationParams
    */
   virtual void  SendLoadInformation (EpcX2Sap::LoadInformationParams params) = 0;
 

src/lte/model/lte-ffr-sap.h

@@ -97,26 +97,32 @@ public:
 
   /**
    * \brief ReportDlCqiInfo
+   * \param params the struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters
    */
   virtual void ReportDlCqiInfo (const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters& params) = 0;
 
   /**
    * \brief ReportUlCqiInfo
+   * \param params the struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters
    */
   virtual void ReportUlCqiInfo (const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters& params) = 0;
 
   /**
    * \brief ReportUlCqiInfo
+   * \param ulCqiMap the UL CQI map
    */
   virtual void ReportUlCqiInfo ( std::map <uint16_t, std::vector <double> > ulCqiMap ) = 0;
 
   /**
    * \brief GetTpc
+   * \param rnti the RNTI
+   * \returns the TCP
    */
   virtual uint8_t GetTpc (uint16_t rnti) = 0;
 
   /**
-   * \brief GetMinContinuousUlBandwidth
+   * \brief Get the minimum continuous Ul bandwidth
+   * \returns the minimum continuous UL bandwidth
    */
   virtual uint8_t GetMinContinuousUlBandwidth () = 0;
 }; // end of class LteFfrSapProvider

src/lte/model/lte-ffr-soft-algorithm.cc

@@ -81,9 +81,9 @@ static const struct FfrSoftUplinkDefaultConfiguration
   { 3, 100, 28, 48, 24}
 }; ///< the soft uplink default configuration
 
-/// number of downlink configurations
+/** \returns number of downlink configurations */
 const uint16_t NUM_DOWNLINK_CONFS (sizeof (g_ffrSoftDownlinkDefaultConfiguration) / sizeof (FfrSoftDownlinkDefaultConfiguration));
-/// number of uplink configurations
+/** \returns number of uplink configurations */
 const uint16_t NUM_UPLINK_CONFS (sizeof (g_ffrSoftUplinkDefaultConfiguration) / sizeof (FfrSoftUplinkDefaultConfiguration));
 
 

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

@@ -57,8 +57,9 @@ public:
   virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser* s);
   virtual LteFfrRrcSapProvider* GetLteFfrRrcSapProvider ();
 
-  // let the forwarder class access the protected and private members
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrSapProvider<LteFfrSoftAlgorithm>;
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrRrcSapProvider<LteFfrSoftAlgorithm>;
 
 protected:

src/lte/model/lte-fr-hard-algorithm.cc

@@ -78,9 +78,9 @@ static const struct FrHardUplinkDefaultConfiguration
   { 3, 100, 64, 36}
 }; ///< the hard uplink default configuration
 
-/// number of downlink configurations
+/** \returns number of downlink configurations */
 const uint16_t NUM_DOWNLINK_CONFS (sizeof (g_frHardDownlinkDefaultConfiguration) / sizeof (FrHardDownlinkDefaultConfiguration));
-/// number of uplink configurations
+/** \returns number of uplink configurations */
 const uint16_t NUM_UPLINK_CONFS (sizeof (g_frHardUplinkDefaultConfiguration) / sizeof (FrHardUplinkDefaultConfiguration));
 
 LteFrHardAlgorithm::LteFrHardAlgorithm ()

src/lte/model/lte-fr-hard-algorithm.h

@@ -56,8 +56,9 @@ public:
   virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser* s);
   virtual LteFfrRrcSapProvider* GetLteFfrRrcSapProvider ();
 
-  // let the forwarder class access the protected and private members
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrSapProvider<LteFrHardAlgorithm>;
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrRrcSapProvider<LteFrHardAlgorithm>;
 
 protected:

src/lte/model/lte-fr-no-op-algorithm.h

@@ -62,8 +62,9 @@ public:
   virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser* s);
   virtual LteFfrRrcSapProvider* GetLteFfrRrcSapProvider ();
 
-  // let the forwarder class access the protected and private members
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrSapProvider<LteFrNoOpAlgorithm>;
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrRrcSapProvider<LteFrNoOpAlgorithm>;
 
 protected:

src/lte/model/lte-fr-soft-algorithm.cc

@@ -79,9 +79,9 @@ static const struct FrSoftUplinkDefaultConfiguration
   { 3, 100, 64, 36}
 }; ///< soft uplink default configuration
 
-/// number of downlink configurations
+/** \returns number of downlink configurations */
 const uint16_t NUM_DOWNLINK_CONFS (sizeof (g_frSoftDownlinkDefaultConfiguration) / sizeof (FrSoftDownlinkDefaultConfiguration));
-/// number of uplink configurations
+/** \returns number of uplink configurations */
 const uint16_t NUM_UPLINK_CONFS (sizeof (g_frSoftUplinkDefaultConfiguration) / sizeof (FrSoftUplinkDefaultConfiguration));
 
 

src/lte/model/lte-fr-soft-algorithm.h

@@ -57,8 +57,9 @@ public:
   virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser* s);
   virtual LteFfrRrcSapProvider* GetLteFfrRrcSapProvider ();
 
-  // let the forwarder class access the protected and private members
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrSapProvider<LteFrSoftAlgorithm>;
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrRrcSapProvider<LteFrSoftAlgorithm>;
 
 protected:

src/lte/model/lte-fr-strict-algorithm.cc

@@ -81,9 +81,9 @@ static const struct FrStrictUplinkDefaultConfiguration
   { 3, 100, 28, 48, 24}
 }; ///< the strict uplink default configuration
 
-/// number of downlink configurations
+/** \returns number of downlink configurations */
 const uint16_t NUM_DOWNLINK_CONFS (sizeof (g_frStrictDownlinkDefaultConfiguration) / sizeof (FrStrictDownlinkDefaultConfiguration));
-/// number of uplink configurations
+/** \returns number of uplink configurations */
 const uint16_t NUM_UPLINK_CONFS (sizeof (g_frStrictUplinkDefaultConfiguration) / sizeof (FrStrictUplinkDefaultConfiguration));
 
 

src/lte/model/lte-fr-strict-algorithm.h

@@ -57,8 +57,9 @@ public:
   virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser* s);
   virtual LteFfrRrcSapProvider* GetLteFfrRrcSapProvider ();
 
-  // let the forwarder class access the protected and private members
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrSapProvider<LteFrStrictAlgorithm>;
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrRrcSapProvider<LteFrStrictAlgorithm>;
 
 protected:

src/lte/model/lte-net-device.h

@@ -98,7 +98,10 @@ protected:
 private:
   /// type conversion operator
   LteNetDevice (const LteNetDevice &);
-  /// assignment operator
+  /**
+   * assignment operator
+   * \returns LteNetDevice
+   */
   LteNetDevice & operator= (const LteNetDevice &);
 
   Ptr<Node> m_node; ///< the node

src/lte/model/lte-pdcp-tag.h

@@ -50,6 +50,7 @@ public:
   PdcpTag ();
   /**
    * Create an PDCP tag with the given senderTimestamp
+   * \param senderTimestamp the time stamp
    */
   PdcpTag (Time senderTimestamp);
 

src/lte/model/lte-pdcp.h

@@ -36,7 +36,9 @@ namespace ns3 {
  */
 class LtePdcp : public Object // SimpleRefCount<LtePdcp>
 {
+  /// allow LtePdcpSpecificLteRlcSapUser class friend access
   friend class LtePdcpSpecificLteRlcSapUser;
+  /// allow LtePdcpSpecificLtePdcpSapProvider<LtePdcp> class friend access
   friend class LtePdcpSpecificLtePdcpSapProvider<LtePdcp>;
 public:
   LtePdcp ();

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

@@ -45,6 +45,7 @@ public:
 
   /**
    * Create a LtePhyTag with the given RNTI and LC id
+   * \param cellId the cell ID
    */
   LtePhyTag (uint16_t cellId);
 

src/lte/model/lte-radio-bearer-tag.h

@@ -48,11 +48,16 @@ public:
 
   /**
    * Create a LteRadioBearerTag with the given RNTI and LC id
+   * \param rnti the RNTI
+   * \param lcId the LCID
    */
   LteRadioBearerTag (uint16_t  rnti, uint8_t lcId);
   
   /**
   * Create a LteRadioBearerTag with the given RNTI, LC id and layer
+   * \param rnti the RNTI
+   * \param lcId the LCID
+   * \param layer the layer
   */
   LteRadioBearerTag (uint16_t  rnti, uint8_t lcId, uint8_t layer);
 

src/lte/model/lte-rlc-sap.h

@@ -51,6 +51,7 @@ public:
    * Send a PDCP PDU to the RLC for transmission
    * This method is to be called
    * when upper PDCP entity has a PDCP PDU ready to send
+   * \param params the TransmitPdcpPduParameters
    */
   virtual void TransmitPdcpPdu (TransmitPdcpPduParameters params) = 0;
 };
@@ -89,7 +90,10 @@ public:
    */
   LteRlcSpecificLteRlcSapProvider (C* rlc);
 
-  // Interface implemented from LteRlcSapProvider
+  /**
+   * Interface implemented from LteRlcSapProvider
+   * \param params the TransmitPdcpPduParameters
+   */
   virtual void TransmitPdcpPdu (TransmitPdcpPduParameters params);
 
 private:

src/lte/model/lte-rlc-sequence-number.h

@@ -99,7 +99,10 @@ public:
     m_modulusBase = modulusBase;
   }
 
-  /// postfix ++ operator
+  /**
+   * postfix ++ operator
+   * \returns SequenceNumber10
+   */
   SequenceNumber10 operator++ (int)
   {
     SequenceNumber10 retval (m_value);
@@ -108,7 +111,11 @@ public:
     return retval;
   }
 
-  /// addition operator
+  /**
+   * addition operator
+   * \param delta the amount to add
+   * \returns SequenceNumber10
+   */
   SequenceNumber10 operator + (uint16_t delta) const
   {
     SequenceNumber10 ret ((m_value + delta) % 1024);
@@ -116,7 +123,11 @@ public:
     return ret;
   }
 
-  /// subtraction operator
+  /**
+   * subtraction operator
+   * \param delta the amount to subtract
+   * \returns SequenceNumber10
+   */
   SequenceNumber10 operator - (uint16_t delta) const
   {
     SequenceNumber10 ret ((m_value - delta) % 1024);
@@ -124,14 +135,22 @@ public:
     return ret;
   }
 
-  /// subtraction operator
+  /**
+   * subtraction operator
+   * \param other the amount to subtract
+   * \returns SequenceNumber10
+   */
   uint16_t operator - (const SequenceNumber10 &other) const
   {
     uint16_t diff = m_value - other.m_value;
     return (diff);
   }
 
-  /// greater than operator
+  /**
+   * greater than operator
+   * \param other the object to compare
+   * \returns true if greater than
+   */
   bool operator > (const SequenceNumber10 &other) const
   {
     SequenceNumber10 v1 ((m_value - m_modulusBase) % 1024);
@@ -139,31 +158,51 @@ public:
     return ( v1.GetValue () > v2.GetValue () );
   }
 
-  /// equaity operator
+  /**
+   * equality operator
+   * \param other the object to compare
+   * \returns true if equal
+   */
   bool operator == (const SequenceNumber10 &other) const
   {
     return (m_value == other.m_value);
   }
 
-  /// inequality operator
+  /**
+   * inequality operator
+   * \param other the object to compare
+   * \returns true if not equal
+   */
   bool operator != (const SequenceNumber10 &other) const
   {
     return (m_value != other.m_value);
   }
 
-  /// less than or equal operator
+  /**
+   * less than or equal operator
+   * \param other the object to compare
+   * \returns true if less than or equal
+   */
   bool operator <= (const SequenceNumber10 &other) const
   {
     return (!this->operator> (other));
   }
 
-  /// greater than or equal operator
+  /**
+   * greater than or equal operator
+   * \param other the object to compare
+   * \returns true if greater than or equal
+   */
   bool operator >= (const SequenceNumber10 &other) const
   {
     return (this->operator> (other) || this->operator== (other));
   }
 
-  /// less than operator
+  /**
+   * less than operator
+   * \param other the object to compare
+   * \returns true if less than
+   */
   bool operator < (const SequenceNumber10 &other) const
   {
     return !this->operator> (other) && m_value != other.m_value;

src/lte/model/lte-rlc-tag.h

@@ -48,7 +48,8 @@ public:
    */
   RlcTag ();
   /**
-   * Create an RLC tag with the given senderTimestamp
+   * Create an RLC tag with the given senderTimestamp 
+   * \param senderTimestamp the time
    */
   RlcTag (Time senderTimestamp);
 

src/lte/model/lte-rlc.h

@@ -49,7 +49,9 @@ namespace ns3 {
  */
 class LteRlc : public Object // SimpleRefCount<LteRlc>
 {
+  /// allow LteRlcSpecificLteMacSapUser class friend access
   friend class LteRlcSpecificLteMacSapUser;
+  /// allow LteRlcSpecificLteRlcSapProvider<LteRlc> class friend access
   friend class LteRlcSpecificLteRlcSapProvider<LteRlc>;
 public:
   LteRlc ();

src/lte/model/lte-rrc-protocol-ideal.h

@@ -47,6 +47,7 @@ class LteUeRrc;
  */
 class LteUeRrcProtocolIdeal : public Object
 {
+  /// allow MemberLteUeRrcSapUser<LteUeRrcProtocolIdeal> class friend access
   friend class MemberLteUeRrcSapUser<LteUeRrcProtocolIdeal>;
 
 public:
@@ -149,6 +150,7 @@ private:
  */
 class LteEnbRrcProtocolIdeal : public Object
 {
+  /// allow MemberLteEnbRrcSapUser<LteEnbRrcProtocolIdeal> class friend access
   friend class MemberLteEnbRrcSapUser<LteEnbRrcProtocolIdeal>;
 
 public:

src/lte/model/lte-rrc-protocol-real.h

@@ -52,8 +52,11 @@ class LteUeRrc;
  */
 class LteUeRrcProtocolReal : public Object
 {
+  /// allow MemberLteUeRrcSapUser<LteUeRrcProtocolReal> class friend access
   friend class MemberLteUeRrcSapUser<LteUeRrcProtocolReal>;
+  /// allow LteRlcSpecificLteRlcSapUser<LteUeRrcProtocolReal> class friend access
   friend class LteRlcSpecificLteRlcSapUser<LteUeRrcProtocolReal>;
+  /// allow LtePdcpSpecificLtePdcpSapUser<LteUeRrcProtocolReal> class friend access
   friend class LtePdcpSpecificLtePdcpSapUser<LteUeRrcProtocolReal>;
 
 public:
@@ -170,9 +173,13 @@ private:
  */
 class LteEnbRrcProtocolReal : public Object
 {
+  /// allow MemberLteEnbRrcSapUser<LteEnbRrcProtocolReal> class friend access
   friend class MemberLteEnbRrcSapUser<LteEnbRrcProtocolReal>;
+  /// allow LtePdcpSpecificLtePdcpSapUser<LteEnbRrcProtocolReal> class friend access
   friend class LtePdcpSpecificLtePdcpSapUser<LteEnbRrcProtocolReal>;
+  /// allow LteRlcSpecificLteRlcSapUser<LteEnbRrcProtocolReal> class friend access
   friend class LteRlcSpecificLteRlcSapUser<LteEnbRrcProtocolReal>;
+  /// allow RealProtocolRlcSapUser class friend access
   friend class RealProtocolRlcSapUser;
 
 public:

src/lte/model/lte-rrc-sap.h

@@ -94,7 +94,8 @@ public:
   /// RlcConfig structure
   struct RlcConfig
   {
-    enum
+    /// the direction choice
+    enum direction
     {
       AM,
       UM_BI_DIRECTIONAL,
@@ -115,7 +116,8 @@ public:
   /// SoundingRsUlConfigCommon structure
   struct SoundingRsUlConfigCommon
   {
-    enum
+    /// the config action
+    enum action
     {
       SETUP, RESET
     } type; ///< action type
@@ -126,7 +128,8 @@ public:
   /// SoundingRsUlConfigDedicated structure
   struct SoundingRsUlConfigDedicated
   {
-    enum
+    /// the config action
+    enum action
     {
       SETUP, RESET
     } type; ///< action type
@@ -150,11 +153,11 @@ public:
   /// PdschConfigDedicated structure
   struct PdschConfigDedicated
   {
-    /*
+    /**
      * P_A values, TS 36.331 6.3.2 PDSCH-Config
      * ENUMERATED { dB-6, dB-4dot77, dB-3, dB-1dot77, dB0, dB1, dB2, dB3 }
      */
-    enum
+    enum db
     {
       dB_6,
       dB_4dot77,
@@ -383,7 +386,8 @@ public:
     /// Time during which specific criteria for the event needs to be met in order to trigger a measurement report.
     uint16_t timeToTrigger;
 
-    enum
+    /// the report purpose
+    enum report
     {
       REPORT_STRONGEST_CELLS,
       REPORT_CGI
@@ -460,11 +464,13 @@ public:
   /// MeasGapConfig structure
   struct MeasGapConfig
   {
-    enum
+    /// the action type
+    enum action
     {
       SETUP, RESET
     } type; ///< action type
-    enum
+    /// the gap offest
+    enum gap
     {
       GP0, GP1
     } gapOffsetChoice; ///< gap offset
@@ -491,7 +497,8 @@ public:
   /// SpeedStatePars structure
   struct SpeedStatePars
   {
-    enum
+    /// the action type
+    enum action
     {
       SETUP,
       RESET

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

@@ -441,6 +441,7 @@ public:
    */
   Ptr<SpectrumChannel> GetChannel ();
 
+  /// allow LteUePhy class friend access
   friend class LteUePhy;
   
  /**

src/lte/model/lte-spectrum-signal-parameters.h

@@ -49,6 +49,7 @@ struct LteSpectrumSignalParameters : public SpectrumSignalParameters
 
   /**
    * copy constructor
+   * \param p the LteSpectrumSignalParameters to copy
    */
   LteSpectrumSignalParameters (const LteSpectrumSignalParameters& p);
 
@@ -79,6 +80,7 @@ struct LteSpectrumSignalParametersDataFrame : public SpectrumSignalParameters
   
   /**
   * copy constructor
+  * \param p the LteSpectrumSignalParametersDataFrame to copy
   */
   LteSpectrumSignalParametersDataFrame (const LteSpectrumSignalParametersDataFrame& p);
   
@@ -111,6 +113,7 @@ struct LteSpectrumSignalParametersDlCtrlFrame : public SpectrumSignalParameters
   
   /**
   * copy constructor
+  * \param p the LteSpectrumSignalParametersDlCtrlFrame to copy
   */
   LteSpectrumSignalParametersDlCtrlFrame (const LteSpectrumSignalParametersDlCtrlFrame& p);
 
@@ -141,6 +144,7 @@ struct LteSpectrumSignalParametersUlSrsFrame : public SpectrumSignalParameters
   
   /**
   * copy constructor
+  * \param p the LteSpectrumSignalParametersUlSrsFrame to copy
   */
   LteSpectrumSignalParametersUlSrsFrame (const LteSpectrumSignalParametersUlSrsFrame& p);
   

src/lte/model/lte-ue-ccm-rrc-sap.h

@@ -44,6 +44,7 @@ namespace ns3 {
 class LteUeCcmRrcSapProvider
 {
 
+/// allow  LteMacSapUser class friend access
 friend class LteMacSapUser;
  
 public:

src/lte/model/lte-ue-component-carrier-manager.h

@@ -75,6 +75,7 @@ public:
   /**
    * \brief Returns the MAC sap provider interface that if forwarding calls to the
    * instance of the LteUeComponentCarrierManager.
+   * \return the reference to the "provider" part of the interface
    */
   virtual LteMacSapProvider* GetLteMacSapProvider () = 0;
 
@@ -88,6 +89,7 @@ public:
 
   /**
    * \brief Sets number of component carriers that are supported by this UE.
+   * \param noOfComponentCarriers numbr of compoent carriers
    */
   void SetNumberOfComponentCarriers (uint8_t noOfComponentCarriers);
 

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

@@ -42,8 +42,11 @@ class UniformRandomVariable;
 
 class LteUeMac :   public Object
 {
+  /// allow UeMemberLteUeCmacSapProvider class friend access
   friend class UeMemberLteUeCmacSapProvider;
+  /// allow UeMemberLteMacSapProvider class friend access
   friend class UeMemberLteMacSapProvider;
+  /// allow UeMemberLteUePhySapUser class friend access
   friend class UeMemberLteUePhySapUser;
 
 public:

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

@@ -51,7 +51,9 @@ class LteHarqPhy;
 class LteUePhy : public LtePhy
 {
 
+  /// allow UeMemberLteUePhySapProvider class friend access
   friend class UeMemberLteUePhySapProvider;
+  /// allow MemberLteUeCphySapProvider<LteUePhy> class friend access
   friend class MemberLteUeCphySapProvider<LteUePhy>;
 
 public:
@@ -227,6 +229,7 @@ public:
 
   /**
    * \brief PhySpectrum received a new PHY-PDU
+   * \param p the packet received
    */
   void PhyPduReceived (Ptr<Packet> p);
 
@@ -247,11 +250,13 @@ public:
 
   /**
    * \brief PhySpectrum generated a new DL HARQ feedback
+   * \param mes the DlInfoListElement_s
    */
   virtual void ReceiveLteDlHarqFeedback (DlInfoListElement_s mes);
 
   /**
    * \brief Set the HARQ PHY module
+   * \param harq the HARQ PHY module
    */
   void SetHarqPhyModule (Ptr<LteHarqPhy> harq);
 

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

@@ -79,12 +79,19 @@ class LteSignalingRadioBearerInfo;
 class LteUeRrc : public Object
 {
 
+  /// allow UeMemberLteUeCmacSapUser class friend access
   friend class UeMemberLteUeCmacSapUser;
+  /// allow UeRrcMemberLteEnbCmacSapUser class friend access
   friend class UeRrcMemberLteEnbCmacSapUser;
+  /// allow LtePdcpSpecificLtePdcpSapUser<LteUeRrc> class friend access
   friend class LtePdcpSpecificLtePdcpSapUser<LteUeRrc>;
+  /// allow MemberLteAsSapProvider<LteUeRrc> class friend access
   friend class MemberLteAsSapProvider<LteUeRrc>;
+  /// allow MemberLteUeCphySapUser<LteUeRrc> class friend access
   friend class MemberLteUeCphySapUser<LteUeRrc>;
+  /// allow MemberLteUeRrcSapProvider<LteUeRrc> class friend access
   friend class MemberLteUeRrcSapProvider<LteUeRrc>;
+  /// allow MemberLteUeCcmRrcSapUser<LteUeRrc> class friend access
   friend class MemberLteUeCcmRrcSapUser<LteUeRrc>;
 
 public:
@@ -427,13 +434,25 @@ private:
 
   // RRC SAP methods
 
-  /// Part of the RRC protocol. Implement the LteUeRrcSapProvider::CompleteSetup interface.
+  /**
+   * Part of the RRC protocol. Implement the LteUeRrcSapProvider::CompleteSetup interface.
+   * \param params the LteUeRrcSapProvider::CompleteSetupParameters
+   */
   void DoCompleteSetup (LteUeRrcSapProvider::CompleteSetupParameters params);
-  /// Part of the RRC protocol. Implement the LteUeRrcSapProvider::RecvSystemInformation interface.
+  /**
+   * Part of the RRC protocol. Implement the LteUeRrcSapProvider::RecvSystemInformation interface.
+   * \param msg the LteRrcSap::SystemInformation
+   */
   void DoRecvSystemInformation (LteRrcSap::SystemInformation msg);
-  /// Part of the RRC protocol. Implement the LteUeRrcSapProvider::RecvRrcConnectionSetup interface.
+  /**
+   * Part of the RRC protocol. Implement the LteUeRrcSapProvider::RecvRrcConnectionSetup interface.
+   * \param msg the LteRrcSap::RrcConnectionSetup
+   */
   void DoRecvRrcConnectionSetup (LteRrcSap::RrcConnectionSetup msg);
-  /// Part of the RRC protocol. Implement the LteUeRrcSapProvider::RecvRrcConnectionReconfiguration interface.
+  /**
+   * Part of the RRC protocol. Implement the LteUeRrcSapProvider::RecvRrcConnectionReconfiguration interface.
+   * \param msg the LteRrcSap::RrcConnectionReconfiguration
+   */
   void DoRecvRrcConnectionReconfiguration (LteRrcSap::RrcConnectionReconfiguration msg);
   /**
    * Part of the RRC protocol. Implement the LteUeRrcSapProvider::RecvRrcConnectionReestablishment interface.
@@ -450,7 +469,10 @@ private:
    * \param msg LteRrcSap::RrcConnectionRelease
    */
   void DoRecvRrcConnectionRelease (LteRrcSap::RrcConnectionRelease msg);
-  /// Part of the RRC protocol. Implement the LteUeRrcSapProvider::RecvRrcConnectionReject interface.
+  /**
+   * Part of the RRC protocol. Implement the LteUeRrcSapProvider::RecvRrcConnectionReject interface.
+   * \param msg the LteRrcSap::RrcConnectionReject
+   */
   void DoRecvRrcConnectionReject (LteRrcSap::RrcConnectionReject msg);
 
   /**

src/lte/model/no-op-component-carrier-manager.h

@@ -42,9 +42,13 @@ class LteCcmRrcSapProvider;
 
 class NoOpComponentCarrierManager : public LteEnbComponentCarrierManager
 {
+  /// allow EnbMacMemberLteMacSapProvider<NoOpComponentCarrierManager> class friend access
   friend class EnbMacMemberLteMacSapProvider<NoOpComponentCarrierManager>;
+  /// allow MemberLteCcmRrcSapProvider<NoOpComponentCarrierManager> class friend access
   friend class MemberLteCcmRrcSapProvider<NoOpComponentCarrierManager>;
+  /// allow MemberLteCcmRrcSapUser<NoOpComponentCarrierManager> class friend access
   friend class MemberLteCcmRrcSapUser<NoOpComponentCarrierManager>;
+  /// allow MemberLteCcmMacSapUser<NoOpComponentCarrierManager> class friend access
   friend class MemberLteCcmMacSapUser<NoOpComponentCarrierManager>;
 
 public:

src/lte/model/no-op-handover-algorithm.h

@@ -56,7 +56,7 @@ public:
   virtual void SetLteHandoverManagementSapUser (LteHandoverManagementSapUser* s);
   virtual LteHandoverManagementSapProvider* GetLteHandoverManagementSapProvider ();
 
-  // let the forwarder class access the protected and private members
+  /// let the forwarder class access the protected and private members
   friend class MemberLteHandoverManagementSapProvider<NoOpHandoverAlgorithm>;
 
 protected:

src/lte/model/pf-ff-mac-scheduler.h

@@ -102,7 +102,9 @@ public:
   virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
   virtual LteFfrSapUser* GetLteFfrSapUser ();
 
+  /// allow MemberCschedSapProvider<PfFfMacScheduler> class friend access
   friend class MemberCschedSapProvider<PfFfMacScheduler>;
+  /// allow MemberSchedSapProvider<PfFfMacScheduler> class friend access  
   friend class MemberSchedSapProvider<PfFfMacScheduler>;
 
   /**

src/lte/model/pss-ff-mac-scheduler.h

@@ -110,7 +110,9 @@ public:
   virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
   virtual LteFfrSapUser* GetLteFfrSapUser ();
 
+  /// allow MemberCschedSapProvider<PssFfMacScheduler> class friend access
   friend class MemberCschedSapProvider<PssFfMacScheduler>;
+  /// allow MemberSchedSapProvider<PssFfMacScheduler> class friend access
   friend class MemberSchedSapProvider<PssFfMacScheduler>;
 
   /**

src/lte/model/rr-ff-mac-scheduler.h

@@ -89,7 +89,9 @@ public:
   virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
   virtual LteFfrSapUser* GetLteFfrSapUser ();
 
+  /// allow MemberCschedSapProvider<RrFfMacScheduler> class friend access
   friend class MemberCschedSapProvider<RrFfMacScheduler>;
+  /// allow MemberSchedSapProvider<RrFfMacScheduler> class friend access
   friend class MemberSchedSapProvider<RrFfMacScheduler>;
 
   /**

src/lte/model/simple-ue-component-carrier-manager.h

@@ -58,11 +58,13 @@ public:
 
 
 
-  // let the forwarder class access the protected and private members
+  /// let the forwarder class access the protected and private members
   friend class MemberLteUeCcmRrcSapProvider<SimpleUeComponentCarrierManager>;
   //friend class MemberLteUeCcmRrcSapUser<SimpleUeComponentCarrierManager>;
   
+  /// allow SimpleUeCcmMacSapProvider class friend access
   friend class SimpleUeCcmMacSapProvider;
+  /// allow SimpleUeCcmMacSapUser class friend access
   friend class SimpleUeCcmMacSapUser;
 
 protected:

src/lte/model/tdbet-ff-mac-scheduler.h

@@ -103,7 +103,9 @@ public:
   virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
   virtual LteFfrSapUser* GetLteFfrSapUser ();
 
+  /// allow MemberCschedSapProvider<TdBetFfMacScheduler> class friend access
   friend class MemberCschedSapProvider<TdBetFfMacScheduler>;
+  /// allow MemberSchedSapProvider<TdBetFfMacScheduler> class friend access
   friend class MemberSchedSapProvider<TdBetFfMacScheduler>;
 
   /**

src/lte/model/tdmt-ff-mac-scheduler.h

@@ -94,7 +94,9 @@ public:
   virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
   virtual LteFfrSapUser* GetLteFfrSapUser ();
 
+  /// allow MemberCschedSapProvider<TdMtFfMacScheduler> class friend access
   friend class MemberCschedSapProvider<TdMtFfMacScheduler>;
+  /// allow MemberSchedSapProvider<TdMtFfMacScheduler> class friend access
   friend class MemberSchedSapProvider<TdMtFfMacScheduler>;
 
   /**

src/lte/model/tdtbfq-ff-mac-scheduler.h

@@ -109,7 +109,9 @@ public:
   virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
   virtual LteFfrSapUser* GetLteFfrSapUser ();
 
+  /// allow MemberCschedSapProvider<TdTbfqFfMacScheduler> class friend access
   friend class MemberCschedSapProvider<TdTbfqFfMacScheduler>;
+  /// allow MemberSchedSapProvider<TdTbfqFfMacScheduler> class friend access
   friend class MemberSchedSapProvider<TdTbfqFfMacScheduler>;
 
   /**

src/lte/model/tta-ff-mac-scheduler.h

@@ -94,7 +94,9 @@ public:
   virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
   virtual LteFfrSapUser* GetLteFfrSapUser ();
 
+  /// allow MemberCschedSapProvider<TtaFfMacScheduler> class friend access
   friend class MemberCschedSapProvider<TtaFfMacScheduler>;
+  /// allow MemberSchedSapProvider<TtaFfMacScheduler> class friend access
   friend class MemberSchedSapProvider<TtaFfMacScheduler>;
 
   /**

src/lte/test/lte-ffr-simple.h

@@ -84,8 +84,9 @@ public:
   virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser* s);
   virtual LteFfrRrcSapProvider* GetLteFfrRrcSapProvider ();
 
-  // let the forwarder class access the protected and private members
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrSapProvider<LteFfrSimple>;
+  /// let the forwarder class access the protected and private members
   friend class MemberLteFfrRrcSapProvider<LteFfrSimple>;
 
   /**

src/lte/test/lte-test-cell-selection.h

@@ -114,6 +114,9 @@ private:
   /**
    * \brief Verifies if the given UE is attached to either of the given two
    *        cells and in a CONNECTED_NORMALLY state.
+   * \param ueDev the UE device
+   * \param expectedCellId1 the first cell ID
+   * \param expectedCellId2 the second cell ID
    */
   void CheckPoint (Ptr<LteUeNetDevice> ueDev, uint16_t expectedCellId1,
                    uint16_t expectedCellId2);

src/lte/test/lte-test-cqi-generation.h

@@ -43,7 +43,7 @@ public:
  * \ingroup lte-test
  * \ingroup tests
  *
- * \brief This is the test suite for testing different configuration of CQI generation.
+ * \brief This is the test case for testing different configuration of CQI generation.
  *  The topology consists of the two UEs and two eNbs. UEs have the same position,
  *  while eNodeBs are at the same distance from both UEs. The checking whether CQI is 
  *  generated properly for two different cases: when PDCCH is used for the CQI 
@@ -54,7 +54,7 @@ class LteCqiGenerationTestCase : public TestCase
 {
 public:
   /**
-   * Constructor
+   * \Constructor
    *
    * \param name reference name
    * \param usePdcchForCqiGeneration use PDCCH for CQI generation
@@ -95,7 +95,7 @@ private:
  * \ingroup lte-test
  * \ingroup tests
  *
- * \brief This test is very simillar to LteCqiGenerationTestCase. The difference is that in this 
+ * \brief This test is very similar to LteCqiGenerationTestCase. The difference is that in this
  * test is enabled the downlink power control.
  */
 

src/lte/test/lte-test-downlink-sinr.h

@@ -56,6 +56,13 @@ public:
 class LteDownlinkDataSinrTestCase : public TestCase
 {
 public:
+  /**
+   * Constructor
+   *
+   * \param sv the spectrum value
+   * \param sinr the SINR
+   * \param name the name of the test
+   */
   LteDownlinkDataSinrTestCase (Ptr<SpectrumValue> sv, Ptr<SpectrumValue> sinr, std::string name);
   virtual ~LteDownlinkDataSinrTestCase ();
 
@@ -83,6 +90,13 @@ private:
 class LteDownlinkCtrlSinrTestCase : public TestCase
 {
   public:
+  /**
+   * Constructor
+   *
+   * \param sv the spectrum value
+   * \param sinr the SINR
+   * \param name the name of the test
+   */
     LteDownlinkCtrlSinrTestCase (Ptr<SpectrumValue> sv, Ptr<SpectrumValue> sinr, std::string name);
     virtual ~LteDownlinkCtrlSinrTestCase ();
   

src/lte/test/lte-test-entities.h

@@ -41,6 +41,7 @@ namespace ns3 {
  */
 class LteTestRrc : public Object
 {
+    /// allow LtePdcpSpecificLtePdcpSapUser<LteTestRrc> class friend access
     friend class LtePdcpSpecificLtePdcpSapUser<LteTestRrc>;
 //   friend class EnbMacMemberLteEnbCmacSapProvider;
 //   friend class EnbMacMemberLteMacSapProvider<LteTestMac>;
@@ -139,7 +140,10 @@ class LteTestRrc : public Object
     void SetDevice (Ptr<NetDevice> device);
 
   private:
-    // Interface forwarded by LtePdcpSapUser
+    /**
+     * Interface forwarded by LtePdcpSapUser
+     * \param params the LtePdcpSapUser::ReceivePdcpSduParameters
+     */
     virtual void DoReceivePdcpSdu (LtePdcpSapUser::ReceivePdcpSduParameters params);
 
     LtePdcpSapUser* m_pdcpSapUser; ///< PDCP SAP user
@@ -171,6 +175,7 @@ class LteTestRrc : public Object
  */
 class LteTestPdcp : public Object
 {
+  /// allow LteRlcSpecificLteRlcSapUser<LteTestPdcp> class friend access
   friend class LteRlcSpecificLteRlcSapUser<LteTestPdcp>;
   
   public:
@@ -212,8 +217,11 @@ class LteTestPdcp : public Object
     std::string GetDataReceived (void);
 
   private:
-    // Interface forwarded by LteRlcSapUser
-  virtual void DoReceivePdcpPdu (Ptr<Packet> p);
+    /**
+     * Interface forwarded by LteRlcSapUser
+     * \param p the PDCP PDU packet received
+     */
+    virtual void DoReceivePdcpPdu (Ptr<Packet> p);
 
     LteRlcSapUser* m_rlcSapUser; ///< RLC SAP user
     LteRlcSapProvider* m_rlcSapProvider; ///< RLC SAP provider
@@ -232,6 +240,7 @@ class LteTestPdcp : public Object
 class LteTestMac : public Object
 {
 //   friend class EnbMacMemberLteEnbCmacSapProvider;
+    /// allow EnbMacMemberLteMacSapProvider<LteTestMac> class friend access
     friend class EnbMacMemberLteMacSapProvider<LteTestMac>;
 //   friend class EnbMacMemberFfMacSchedSapUser;
 //   friend class EnbMacMemberFfMacCschedSapUser;
@@ -406,6 +415,7 @@ class LteTestMac : public Object
  */
 class EpcTestRrc : public Object
 {
+  /// allow MemberEpcEnbS1SapUser<EpcTestRrc> class friend access
   friend class MemberEpcEnbS1SapUser<EpcTestRrc>;
 
 public: