Index: firmware/App/Modes/ModeTreatment.c =================================================================== diff -u -rf88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd -r04f72c18f15a3d7ab960fccea7b99cf93fd9a409 --- firmware/App/Modes/ModeTreatment.c (.../ModeTreatment.c) (revision f88ce1aa5a00106b6ba51a625fe4c1d8f0408cfd) +++ firmware/App/Modes/ModeTreatment.c (.../ModeTreatment.c) (revision 04f72c18f15a3d7ab960fccea7b99cf93fd9a409) @@ -33,10 +33,10 @@ static U32 start; #endif - /** - * @addtogroup HDTreatmentMode - * @{ - */ +/** + * @addtogroup HDTreatmentMode + * @{ + */ // ********** private definitions ********** @@ -160,8 +160,8 @@ * @brief * The execTreatmentMode function executes the Treatment Mode state machine. * @details - * Inputs : none - * Outputs : + * Inputs : currentTreatmentState + * Outputs : currentTreatmentState * @return current state (sub-mode) *************************************************************************/ U32 execTreatmentMode( void ) @@ -246,11 +246,11 @@ /*********************************************************************//** * @brief - * The handleTreatmentStartState function handles the Start state of \n + * The handleTreatmentStartState function handles the Start state of * the Treatment Mode state machine. * @details * Inputs : none - * Outputs : none + * Outputs : treatmentTimeMS, lastTreatmentTimeStamp * @return next treatment mode state *************************************************************************/ static TREATMENT_STATE_T handleTreatmentStartState( void ) @@ -277,11 +277,12 @@ /*********************************************************************//** * @brief - * The handleTreatmentDialysisState function handles the Dialysis state of \n + * The handleTreatmentDialysisState function handles the Dialysis state of * the Treatment Mode state machine. * @details * Inputs : none - * Outputs : none + * Outputs : treatmentTimeMS, lastTreatmentTimeStamp, dialysis sub-mode + * executed. * @return next treatment mode state *************************************************************************/ static TREATMENT_STATE_T handleTreatmentDialysisState( void ) @@ -328,11 +329,11 @@ /*********************************************************************//** * @brief - * The handleTreatmentStopState function executes the Stop state of the \n + * The handleTreatmentStopState function executes the Stop state of the * Treatment Mode state machine. * @details * Inputs : none - * Outputs : none + * Outputs : treatment stop sub-mode executed. * @return next treatment mode state *************************************************************************/ static TREATMENT_STATE_T handleTreatmentStopState( void ) @@ -364,7 +365,7 @@ /*********************************************************************//** * @brief - * The verifyTreatmentDurationSettingChange function verifies and responds to \n + * The verifyTreatmentDurationSettingChange function verifies and responds to * the user treatment duration setting change request. * @details * Inputs : current operating mode, treatment states and parameters @@ -443,7 +444,7 @@ /*********************************************************************//** * @brief - * The verifyUFSettingsChange function verifies and responds to a new \n + * The verifyUFSettingsChange function verifies and responds to a new * ultrafiltration volume setting from the user. * @details * Inputs : current operating mode, treatment states and parameters @@ -546,7 +547,7 @@ /*********************************************************************//** * @brief - * The verifyUFSettingsConfirmation function verifies the user confirmed \n + * The verifyUFSettingsConfirmation function verifies the user confirmed * ultrafiltration settings change(s) and, if valid, accepts the new settings. * @details * Inputs : current operating mode, treatment states and parameters @@ -610,7 +611,7 @@ /*********************************************************************//** * @brief - * The verifyBloodAndDialysateRateSettingsChange function verifies the \n + * The verifyBloodAndDialysateRateSettingsChange function verifies the * user blood & dialysate flow rate settings change. * @details * Inputs : current operating mode, treatment states and parameters @@ -670,7 +671,7 @@ /*********************************************************************//** * @brief - * The broadcastTreatmentTimeAndState function broadcasts treatment time and \n + * The broadcastTreatmentTimeAndState function broadcasts treatment time and * state data during treatment. * @details * Inputs : treatment time and state data @@ -705,9 +706,9 @@ /*********************************************************************//** * @brief - * The broadcastTreatmentSettingsRanges function computes and broadcasts \n - * updated treatment parameter ranges that the user may change during treatment. \n - * It is assumed that prescription settings have already been set prior to calling \n + * The broadcastTreatmentSettingsRanges function computes and broadcasts + * updated treatment parameter ranges that the user may change during treatment. + * It is assumed that prescription settings have already been set prior to calling * this function. * @details * Inputs : current operating mode, treatment states and parameters