Updated TODO tags to Doxygen format

This commit is contained in:
Budiarto Herman
2013-09-23 17:58:32 +03:00
parent 41d7f8e590
commit 990cf5a7a7
7 changed files with 37 additions and 14 deletions

View File

@@ -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;
}

View File

@@ -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<uint16_t, Ptr<UeMeasure> > MeasurementRow_t;

View File

@@ -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;
}

View File

@@ -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

View File

@@ -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)

View File

@@ -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;

View File

@@ -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