From 990cf5a7a7b1f5f8a792928fd92e4019bb611b7d Mon Sep 17 00:00:00 2001 From: Budiarto Herman Date: Mon, 23 Sep 2013 17:58:32 +0300 Subject: [PATCH] Updated TODO tags to Doxygen format --- .../model/a2-a4-rsrq-handover-algorithm.cc | 7 +++++- src/lte/model/a2-a4-rsrq-handover-algorithm.h | 2 +- src/lte/model/a3-rsrp-handover-algorithm.cc | 7 +++++- src/lte/model/epc-ue-nas.cc | 6 ++++- src/lte/model/lte-anr.cc | 2 +- src/lte/model/lte-enb-rrc.cc | 2 +- src/lte/model/lte-ue-rrc.cc | 25 +++++++++++++------ 7 files changed, 37 insertions(+), 14 deletions(-) diff --git a/src/lte/model/a2-a4-rsrq-handover-algorithm.cc b/src/lte/model/a2-a4-rsrq-handover-algorithm.cc index 2574e64fa..0d49d04e6 100644 --- a/src/lte/model/a2-a4-rsrq-handover-algorithm.cc +++ b/src/lte/model/a2-a4-rsrq-handover-algorithm.cc @@ -225,7 +225,12 @@ A2A4RsrqHandoverAlgorithm::IsValidNeighbour (uint16_t cellId) { NS_LOG_FUNCTION (this << cellId); - // TODO + /** + * \todo In the future, this function can be expanded to validate whether the + * neighbour cell is a valid target cell, e.g., taking into account the + * NRT in ANR and whether it is a CSG cell with closed access. + */ + return true; } diff --git a/src/lte/model/a2-a4-rsrq-handover-algorithm.h b/src/lte/model/a2-a4-rsrq-handover-algorithm.h index cbfd58bd5..9d252d92c 100644 --- a/src/lte/model/a2-a4-rsrq-handover-algorithm.h +++ b/src/lte/model/a2-a4-rsrq-handover-algorithm.h @@ -100,7 +100,7 @@ private: uint8_t m_rsrp; uint8_t m_rsrq; }; - // TODO instead of class, try using struct or SimpleRefCount + /// \todo Instead of class, try using struct or SimpleRefCount for UeMeasure. // cellId typedef std::map > MeasurementRow_t; diff --git a/src/lte/model/a3-rsrp-handover-algorithm.cc b/src/lte/model/a3-rsrp-handover-algorithm.cc index 258e2518f..0f557b39b 100644 --- a/src/lte/model/a3-rsrp-handover-algorithm.cc +++ b/src/lte/model/a3-rsrp-handover-algorithm.cc @@ -175,7 +175,12 @@ A3RsrpHandoverAlgorithm::IsValidNeighbour (uint16_t cellId) { NS_LOG_FUNCTION (this << cellId); - // TODO + /** + * \todo In the future, this function can be expanded to validate whether the + * neighbour cell is a valid target cell, e.g., taking into account the + * NRT in ANR and whether it is a CSG cell with closed access. + */ + return true; } diff --git a/src/lte/model/epc-ue-nas.cc b/src/lte/model/epc-ue-nas.cc index 576cd7e95..1128bcdce 100644 --- a/src/lte/model/epc-ue-nas.cc +++ b/src/lte/model/epc-ue-nas.cc @@ -235,7 +235,11 @@ EpcUeNas::DoNotifyConnectionFailed () NS_LOG_FUNCTION (this); SwitchToState (OFF); - // TODO + /** + * \todo Currently not implemented, action by NAS and upper layers after UE + * fails to switch to CONNNECTED mode. Maybe a retry, or just stop here + * and fire a trace to let user know. + */ } void diff --git a/src/lte/model/lte-anr.cc b/src/lte/model/lte-anr.cc index 2458d5a79..5bebd78e0 100644 --- a/src/lte/model/lte-anr.cc +++ b/src/lte/model/lte-anr.cc @@ -197,7 +197,7 @@ LteAnr::DoReportUeMeas (LteRrcSap::MeasResults measResults) else { NS_LOG_WARN (this << " Event A4 received without measurement results from neighbouring cells"); - // TODO Remove neighbours in the NRT + /// \todo Remove neighbours in the NRT. } } // end of else of if (measId != m_measId) diff --git a/src/lte/model/lte-enb-rrc.cc b/src/lte/model/lte-enb-rrc.cc index 4156f73a2..daa8f7d98 100644 --- a/src/lte/model/lte-enb-rrc.cc +++ b/src/lte/model/lte-enb-rrc.cc @@ -1505,7 +1505,7 @@ LteEnbRrc::AddUeMeasReportConfig (LteRrcSap::ReportConfigEutra config) { NS_FATAL_ERROR ("AddUeMeasReportConfig may not be called after the simulation has run"); } - // TODO more asserts to validate the input + /// \todo More asserts to validate the input. uint8_t nextId = m_ueMeasConfig.reportConfigToAddModList.size () + 1; diff --git a/src/lte/model/lte-ue-rrc.cc b/src/lte/model/lte-ue-rrc.cc index a6e6aa4f9..f686ef2cd 100644 --- a/src/lte/model/lte-ue-rrc.cc +++ b/src/lte/model/lte-ue-rrc.cc @@ -534,8 +534,11 @@ LteUeRrc::DoNotifyRandomAccessFailed () case CONNECTED_HANDOVER: { m_handoverEndErrorTrace (m_imsi, m_cellId, m_rnti); - // TODO Send RRC Connection Re-establishment - // TODO Switch to CONNECTED_REESTABLISHING + /** + * \todo After a handover failure because of a random access failure, + * send an RRC Connection Re-establishment and switch to + * CONNECTED_REESTABLISHING state. + */ } break; @@ -912,10 +915,13 @@ LteUeRrc::DoRecvRrcConnectionReestablishment (LteRrcSap::RrcConnectionReestablis { case CONNECTED_REESTABLISHING: { - // TODO Stop T301 - // TODO Fire trace source Connection Re-established - // TODO Send RRC Connection Re-establishment Complete - // TODO Switch to CONNECTED_NORMALLY + /** + * \todo After receiving RRC Connection Re-establishment, stop timer + * T301, fire a new trace source, reply with RRC Connection + * Re-establishment Complete, and finally switch to + * CONNECTED_NORMALLY state. See Section 5.3.7.5 of 3GPP TS + * 36.331. + */ } break; @@ -933,7 +939,10 @@ LteUeRrc::DoRecvRrcConnectionReestablishmentReject (LteRrcSap::RrcConnectionRees { case CONNECTED_REESTABLISHING: { - // TODO Stop T301 + /** + * \todo After receiving RRC Connection Re-establishment Reject, stop + * timer T301. See Section 5.3.7.8 of 3GPP TS 36.331. + */ LeaveConnectedMode (); } break; @@ -948,7 +957,7 @@ void LteUeRrc::DoRecvRrcConnectionRelease (LteRrcSap::RrcConnectionRelease msg) { NS_LOG_FUNCTION (this << " RNTI " << m_rnti); - // TODO + /// \todo Currently not implemented, see Section 5.3.8 of 3GPP TS 36.331. } void