Index: firmware/App/Modes/StateTxRecirc.c =================================================================== diff -u -r1275f9e92eb1ab0cd1b321c0c8eb940524e22117 -r909d4064e98d5684ee139534f0ac6cbc5f8774d5 --- firmware/App/Modes/StateTxRecirc.c (.../StateTxRecirc.c) (revision 1275f9e92eb1ab0cd1b321c0c8eb940524e22117) +++ firmware/App/Modes/StateTxRecirc.c (.../StateTxRecirc.c) (revision 909d4064e98d5684ee139534f0ac6cbc5f8774d5) @@ -84,8 +84,8 @@ * @brief * The initTreatmentRecirc function initializes the Treatment Re-circulate * sub-mode module. - * @details Inputs: none - * @details Outputs: Treatment Re-circulate sub-mode module initialized. + * @details \b Inputs: none + * @details \b Outputs: Treatment Re-circulate sub-mode module initialized. * @return none *************************************************************************/ void initTreatmentRecirc( void ) @@ -107,8 +107,8 @@ /*********************************************************************//** * @brief * The resetTreatmentRecircFlags function resets all re-circ request flags. - * @details Inputs: none - * @details Outputs: all request flags set to FALSE. + * @details \b Inputs: none + * @details \b Outputs: all request flags set to FALSE. * @return none *************************************************************************/ static void resetTreatmentRecircFlags( void ) @@ -123,8 +123,8 @@ * @brief * The transitionToTreatmentRecirc function prepares for transition to * Treatment Re-circulate sub-mode. - * @details Inputs: none - * @details Outputs: none + * @details \b Inputs: none + * @details \b Outputs: none * @return none *************************************************************************/ void transitionToTreatmentRecirc( void ) @@ -152,8 +152,8 @@ * @brief * The setupForRecirculationState function configures actuators for the * active re-circulation (Recirc) state. - * @details Inputs: none - * @details Outputs: none + * @details \b Inputs: none + * @details \b Outputs: none * @return none *************************************************************************/ static void setupForRecirculationState( void ) @@ -170,8 +170,8 @@ * @brief * The setupForRecirculationStopState function configures actuators for * Disconnect Patient, Stopped, Reconnect Patient states. - * @details Inputs: none - * @details Outputs: none + * @details \b Inputs: none + * @details \b Outputs: none * @return none *************************************************************************/ static void setupForRecirculationStopState( void ) @@ -191,8 +191,8 @@ * Only fires each alarm once per re-circulate session. * @details \b Alarms: ALARM_ID_TD_RECIRC_TIMEOUT_WARNING if 10 mins left from timeout, * ALARM_ID_TD_RECIRC_TIMEOUT if recirculation timeout - * @details Inputs: recircTimerCtr, recircWarningTicks, recircTimeoutTicks, recircWarningAlarmFired - * @details Outputs: recircWarningAlarmFired, recircTimeoutAlarmFired + * @details \b Inputs: recircTimerCtr, recircWarningTicks, recircTimeoutTicks, recircWarningAlarmFired + * @details \b Outputs: recircWarningAlarmFired, recircTimeoutAlarmFired * @return none *************************************************************************/ static void handleRecircTimeouts( void ) @@ -214,8 +214,8 @@ * @brief * The execTreatmentRecirc function executes the Treatment Re-circulate * sub-mode state machine. - * @details Inputs: currentRecircState - * @details Outputs: currentRecircState, recircTimerCtr + * @details \b Inputs: currentRecircState + * @details \b Outputs: currentRecircState, recircTimerCtr * @return none *************************************************************************/ void execTreatmentRecirc( void ) @@ -269,8 +269,8 @@ * The handleRecircDisconnectPatientState function handles the Disconnect * Patient state of Re-circ sub mode. Waits for user to confirm patient * has been disconnected before starting re-circulation. - * @details Inputs: startRecircRequested - * @details Outputs: none + * @details \b Inputs: startRecircRequested + * @details \b Outputs: none * @return next Treatment re-circulate state *************************************************************************/ static TREATMENT_RECIRC_STATE_T handleRecircDisconnectPatientState( void ) @@ -291,8 +291,8 @@ * @brief * The handleRecircRecircState function handles the active Re-circulate * state of Re-circ sub mode. - * @details Inputs: reconnectRequested - * @details Outputs: none + * @details \b Inputs: reconnectRequested + * @details \b Outputs: none * @return next Treatment re-circulate state *************************************************************************/ static TREATMENT_RECIRC_STATE_T handleRecircRecircState( void ) @@ -323,8 +323,8 @@ * @brief * The handleRecircStoppedState function handles the Stopped state of * Re-circ sub mode. - * @details Inputs: resumeRecircRequested - * @details Outputs: none + * @details \b Inputs: resumeRecircRequested + * @details \b Outputs: none * @return next Treatment re-circulate state *************************************************************************/ static TREATMENT_RECIRC_STATE_T handleRecircStoppedState( void ) @@ -345,8 +345,8 @@ * @brief * The handleRecircReconnectPatientState function handles the Reconnect * Patient state of Re-circ sub mode. - * @details Inputs: backToTreatmentRequested - * @details Outputs: none + * @details \b Inputs: backToTreatmentRequested + * @details \b Outputs: none * @return next Treatment re-circulate state *************************************************************************/ static TREATMENT_RECIRC_STATE_T handleRecircReconnectPatientState( void ) @@ -366,8 +366,8 @@ * @brief * The signalTreatmentRecircUserAction function signals a re-circ user action * has been requested. The request is handled and responded to. - * @details Inputs: none - * @details Outputs: none + * @details \b Inputs: none + * @details \b Outputs: none * @param message UI message which has requested user action * @return TRUE if request is accepted, FALSE if rejected. *************************************************************************/ @@ -436,8 +436,8 @@ * The handleRecircConfirmDisconnectUserAction function handles a confirm * patient disconnect user action request. It is assumed that the calling * function will set the reject reason parameter to None beforehand. - * @details Inputs: currentRecircState - * @details Outputs: startRecircRequested + * @details \b Inputs: currentRecircState + * @details \b Outputs: startRecircRequested * @param rejReason Code indicating reason for rejection * @return TRUE if user action accepted, FALSE if not *************************************************************************/ @@ -463,8 +463,8 @@ * The handleRecircResumeUserAction function handles a re-circulate resume * user action request. It is assumed that the calling function will set * the reject reason parameter to None beforehand. - * @details Inputs: currentRecircState - * @details Outputs: resumeRecircRequested + * @details \b Inputs: currentRecircState + * @details \b Outputs: resumeRecircRequested * @param rejReason Code indicating reason for rejection * @return TRUE if user action accepted, FALSE if not *************************************************************************/ @@ -490,8 +490,8 @@ * The handleRecircReconnectUserAction function handles a re-circulate re-connect * user action request. It is assumed that the calling function will set * the reject reason parameter to None beforehand. - * @details Inputs: currentRecircState - * @details Outputs: reconnectRequested + * @details \b Inputs: currentRecircState + * @details \b Outputs: reconnectRequested * @param rejReason Code indicating reason for rejection * @return TRUE if user action accepted, FALSE if not *************************************************************************/ @@ -517,8 +517,8 @@ * The handleRecicConfirmReconnectUserAction function handles a re-circulate * back to treatment user action request. It is assumed that the calling * function will set the reject reason parameter to None beforehand. - * @details Inputs: currentRecircState - * @details Outputs: backToTreatmentRequested + * @details \b Inputs: currentRecircState + * @details \b Outputs: backToTreatmentRequested * @param rejReason Code indicating reason for rejection * @return TRUE if user action accepted, FALSE if not *************************************************************************/ @@ -547,8 +547,8 @@ * @brief * The getCurrentTreatmentRecircState function returns the current state * of the treatment re-circulate sub-mode. - * @details Inputs: currentRecircState - * @details Outputs: none + * @details \b Inputs: currentRecircState + * @details \b Outputs: none * @return treatmentRecircState *************************************************************************/ TREATMENT_RECIRC_STATE_T getCurrentTreatmentRecircState( void ) @@ -560,8 +560,8 @@ * @brief * The publishTreatmentRecircData function broadcasts re-circulate countdown * data to the UI at 1 Hz. - * @details Inputs: recircPublishTimerCtr, recircTimerCtr - * @details Outputs: none + * @details \b Inputs: recircPublishTimerCtr, recircTimerCtr + * @details \b Outputs: none * @return none *************************************************************************/ static void publishTreatmentRecircData( void )