diff --git a/src/lte/model/epc-enb-application.h b/src/lte/model/epc-enb-application.h index c3dfc3e65..f8397b0d1 100644 --- a/src/lte/model/epc-enb-application.h +++ b/src/lte/model/epc-enb-application.h @@ -72,12 +72,11 @@ public: * Constructor * * \param lteSocket the socket to be used to send/receive IPv4 packets to/from the LTE radio interface - * \param lteSocket the socket to be used to send/receive IPv6 packets to/from the LTE radio interface - * \param s1uSocket the socket to be used to send/receive packets - * to/from the S1-U interface connected with the SGW + * \param lteSocket6 the socket to be used to send/receive IPv6 packets to/from the LTE radio interface + * \param s1uSocket the socket to be used to send/receive packets to/from the S1-U interface connected with the SGW * \param enbS1uAddress the IPv4 address of the S1-U interface of this eNB * \param sgwS1uAddress the IPv4 address at which this eNB will be able to reach its SGW for S1-U communications - * \param cellId the identifier of the enb + * \param cellId the identifier of the eNB */ EpcEnbApplication (Ptr lteSocket, Ptr lteSocket6, Ptr s1uSocket, Ipv4Address enbS1uAddress, Ipv4Address sgwS1uAddress, uint16_t cellId); diff --git a/src/lte/model/lte-enb-rrc.cc b/src/lte/model/lte-enb-rrc.cc index 6c8e850a6..8811a91fd 100644 --- a/src/lte/model/lte-enb-rrc.cc +++ b/src/lte/model/lte-enb-rrc.cc @@ -64,6 +64,7 @@ public: * Constructor * * \param rrc ENB RRC + * \param componentCarrierId */ EnbRrcMemberLteEnbCmacSapUser (LteEnbRrc* rrc, uint8_t componentCarrierId); diff --git a/src/lte/model/lte-enb-rrc.h b/src/lte/model/lte-enb-rrc.h index 1c206d7d1..8e5a3d6cc 100644 --- a/src/lte/model/lte-enb-rrc.h +++ b/src/lte/model/lte-enb-rrc.h @@ -836,7 +836,6 @@ public: /** * \brief Configure cell-specific parameters. - * \param cellId the ID of the cell * * Configure cell-specific parameters and propagate them to lower layers. * The parameters include bandwidth, EARFCN (E-UTRA Absolute Radio Frequency diff --git a/src/lte/model/lte-spectrum-value-helper.h b/src/lte/model/lte-spectrum-value-helper.h index badd263f9..2df860e84 100644 --- a/src/lte/model/lte-spectrum-value-helper.h +++ b/src/lte/model/lte-spectrum-value-helper.h @@ -50,7 +50,7 @@ public: /** * Converts downlink EARFCN to corresponding LTE frequency band number. * - * \param earfcn the EARFCN + * \param nDl the EARFCN * * \return the downlink carrier band */ @@ -59,11 +59,11 @@ public: /** * Converts uplink EARFCN to corresponding LTE frequency band number. * - * \param earfcn the EARFCN + * \param nUl the EARFCN * * \return the uplink carrier band */ - static uint16_t GetUplinkCarrierBand (uint32_t nDl); + static uint16_t GetUplinkCarrierBand (uint32_t nUl); /** * Calculates the downlink carrier frequency from the E-UTRA Absolute diff --git a/src/lte/test/lte-test-aggregation-throughput-scale.h b/src/lte/test/lte-test-aggregation-throughput-scale.h index ca8775f1d..207654c02 100644 --- a/src/lte/test/lte-test-aggregation-throughput-scale.h +++ b/src/lte/test/lte-test-aggregation-throughput-scale.h @@ -61,10 +61,16 @@ private: */ virtual void DoRun (); + /** + * \brief Get throughput function + * + * \param numberOfComponentCarriers Number of component carriers + * \return The total data received (in Megabits) + */ double GetThroughput (uint8_t numberOfComponentCarriers); - uint16_t m_expectedCellId; //< Cell ID UE is expected to attach to - uint16_t m_actualCellId; //< Cell ID UE has attached to + uint16_t m_expectedCellId; ///< Cell ID UE is expected to attach to + uint16_t m_actualCellId; ///< Cell ID UE has attached to }; #endif /* LTE_AGGREGATION_THROUGHPUT_SCALE_H */ diff --git a/src/lte/test/lte-test-carrier-aggregation-configuration.cc b/src/lte/test/lte-test-carrier-aggregation-configuration.cc index afc456b79..86798cce0 100644 --- a/src/lte/test/lte-test-carrier-aggregation-configuration.cc +++ b/src/lte/test/lte-test-carrier-aggregation-configuration.cc @@ -61,25 +61,33 @@ using namespace ns3; * is not static, as reported in BUG 2840. */ +/// ConfigToCheck structure struct ConfigToCheck { - uint16_t m_dlBandwidth; - uint16_t m_ulBandwidth; - uint32_t m_dlEarfcn; - uint32_t m_ulEarfcn; + uint16_t m_dlBandwidth; ///< Downlink bandwidth + uint16_t m_ulBandwidth; ///< Uplink bandwidth + uint32_t m_dlEarfcn; ///< Downlink EARFCN + uint32_t m_ulEarfcn; ///< Uplink EARFCN }; NS_LOG_COMPONENT_DEFINE ("TestCarrierAggregationConfig"); +/** + * \ingroup lte-test + * \ingroup tests + * + * \brief Carrier aggregation configuration test case. + */ class CarrierAggregationConfigTestCase : public TestCase { public: /** * Constructor * - * \param numberOfNodes, Total Number of eNBs and UEs - * \param configToCheck, Vector containing all the configurations to check - * \param simulationDuration, Duration of the simulation + * \param numberOfNodes Total Number of eNBs and UEs + * \param numberOfComponentCarriers Total number of component carriers + * \param configToCheck Vector containing all the configurations to check + * \param simulationDuration Duration of the simulation */ CarrierAggregationConfigTestCase (uint32_t numberOfNodes, uint16_t numberOfComponentCarriers, std::vector configToCheck, Time simulationDuration) : TestCase (BuildNameString (numberOfNodes, numberOfComponentCarriers, configToCheck, simulationDuration)), @@ -94,16 +102,37 @@ public: private: virtual void DoRun (void); + /** + * Build name string function + * + * \param numberOfNodes Total Number of eNBs and UEs + * \param numberOfComponentCarriers Total number of component carriers + * \param configToCheck Vector containing all the configurations to check + * \param simulationDuration Duration of the simulation + * \returns the name string + */ std::string BuildNameString (uint32_t numberOfNodes, uint16_t numberOfComponentCarriers, std::vector configToCheck, Time simulationDuration); + /** + * Evaluate function + * + * \param context The context + * \param ueRrc Pointer to the UE RRC + * \param sCellToAddModList List of the configuration parameters for secondary cell + */ void Evaluate (std::string context, Ptr ueRrc, std::list sCellToAddModList); + /** + * Equally spaced component carriers function + * + * \return Vector of maps containing the per component carrier configuration + */ std::vector > EquallySpacedCcs (); - uint32_t m_numberOfNodes; - uint16_t m_numberOfComponentCarriers; - std::vector m_configToCheck; - uint32_t m_connectionCounter; - Time m_simulationDuration; - std::vector > m_configToCheckContainer; + uint32_t m_numberOfNodes; ///< Numer of nodes + uint16_t m_numberOfComponentCarriers; ///< Number of component carriers + std::vector m_configToCheck; ///< Vector containing all the configurations to check + uint32_t m_connectionCounter; ///< Connection counter + Time m_simulationDuration; ///< Simulation duration + std::vector > m_configToCheckContainer; ///< Vector of maps containing the per component carrier configuration }; std::string @@ -319,7 +348,12 @@ CarrierAggregationConfigTestCase::DoRun () Simulator::Destroy (); } - +/** + * \ingroup lte-test + * \ingroup tests + * + * \brief Carrier aggregation configuration test suite. + */ class CarrierAggregationConfigTestSuite : public TestSuite { public: diff --git a/src/lte/test/lte-test-cqi-generation.h b/src/lte/test/lte-test-cqi-generation.h index 6c440c635..a9964e804 100644 --- a/src/lte/test/lte-test-cqi-generation.h +++ b/src/lte/test/lte-test-cqi-generation.h @@ -54,7 +54,7 @@ class LteCqiGenerationTestCase : public TestCase { public: /** - * \Constructor + * Constructor * * \param name reference name * \param usePdcchForCqiGeneration use PDCCH for CQI generation diff --git a/src/lte/test/lte-test-ipv6-routing.cc b/src/lte/test/lte-test-ipv6-routing.cc index 56675ce38..a930a7033 100644 --- a/src/lte/test/lte-test-ipv6-routing.cc +++ b/src/lte/test/lte-test-ipv6-routing.cc @@ -51,6 +51,12 @@ using namespace ns3; +/** + * \ingroup lte-test + * \ingroup tests + * + * \brief Lte Ipv6 routing test case. + */ class LteIpv6RoutingTestCase : public TestCase { public: @@ -64,29 +70,29 @@ public: /** * \brief sent Packets from client's IPv6 interface. - * \param: p packet - * \param: ipv6 Ipv6 object - * \param: interface Ipv6interface from which the packet is transmitted + * \param p packet + * \param ipv6 Ipv6 object + * \param interface Ipv6interface from which the packet is transmitted */ void SentAtClient (Ptr p, Ptr ipv6, uint32_t interface); /** * \brief Received Packets at client's IPv6 interface. - * \param: p packet - * \param: ipv6 Ipv6 object - * \param: interface Ipv6interface at which the packet is received + * \param p packet + * \param ipv6 Ipv6 object + * \param interface Ipv6interface at which the packet is received */ void ReceivedAtClient (Ptr p, Ptr ipv6, uint32_t interface); /** * \brief Received Packet at pgw from enb. - * \param: p packet + * \param p packet */ void EnbToPgw (Ptr p); /** * \brief Received Packet at pgw from enb. - * \param: p packet + * \param p packet */ void TunToPgw (Ptr p); diff --git a/src/lte/test/test-lte-handover-delay.cc b/src/lte/test/test-lte-handover-delay.cc index e89002615..e4cb57356 100644 --- a/src/lte/test/test-lte-handover-delay.cc +++ b/src/lte/test/test-lte-handover-delay.cc @@ -63,6 +63,7 @@ public: /** * Constructor * + *\param numberOfComponentCarriers number of component carriers * \param useIdealRrc if true, use the ideal RRC * \param handoverTime the time of handover * \param delayThreshold the delay threshold @@ -122,7 +123,7 @@ private: void EnbHandoverEndOkCallback (std::string context, uint64_t imsi, uint16_t cellid, uint16_t rnti); - uint8_t m_numberOfComponentCarriers; + uint8_t m_numberOfComponentCarriers; ///< Number of component carriers bool m_useIdealRrc; ///< use ideal RRC? Time m_handoverTime; ///< handover time Time m_delayThreshold; ///< the delay threshold