Index: firmware/App/Services/TxParams.c =================================================================== diff -u -r679d535b77aa6722671084774ad5d96e9789e12e -r96377d3f1e16d6f8a48fddbe9f645f9e2fd68478 --- firmware/App/Services/TxParams.c (.../TxParams.c) (revision 679d535b77aa6722671084774ad5d96e9789e12e) +++ firmware/App/Services/TxParams.c (.../TxParams.c) (revision 96377d3f1e16d6f8a48fddbe9f645f9e2fd68478) @@ -94,7 +94,6 @@ } DIALIN_SET_TX_PARAM_PAYLOAD_T; #pragma pack(pop) - // ********** private data ********** static const TREATMENT_PARAMS_PROPERTIES_T TREAT_PARAMS_PROPERTIES[ NUM_OF_TREATMENT_PARAMS ] = @@ -172,7 +171,7 @@ * @brief * The getValidTreatParamsReceived function reports whether a valid set * of Treatment Parameters has been staged. -* @details Inputs: none +* @details Inputs: validTreatParamsReceived * @details Outputs: none * @return TRUE if valid parameters are available, FALSE otherwise. **************************************************************************/ @@ -185,7 +184,7 @@ * @brief * The getTreatParamsConfirmed function reports whether the current * Treatment Parameters have been confirmed by the user. - * @details Inputs: none + * @details Inputs: treatParamsConfirmed * @details Outputs: none * @return TRUE if the current Treatment Parameters are confirmed, * FALSE otherwise. @@ -210,13 +209,17 @@ } /*********************************************************************//** -* @brief -* Validate Treatment Parameters received from the UI. -* @details Inputs: message - UI - TD Treatment Parameters validation message. -* @details Outputs: Stages the parameters, performs range/dependency checks, -* and sends validation response including reject reasons. -* @return TRUE if parameters validated successfully, FALSE otherwise. -**************************************************************************/ + * @brief + * The validateAndSetTreatmentParameters function validates received + * treatment parameters. + * @details \b Message \b Sent: MSG_ID_TD_RESP_TREATMENT_PARAMS_TO_VALIDATE + * @details \b Message \b Sent: MSG_ID_TD_TREATMENT_PARAM_RANGES if params are valid + * @details \b Inputs: none + * @details \b Outputs: stagedParams[], validTreatParamsReceived + * @param message set message from UI which includes the user set treatment + * parameters record. + * @return TRUE if received treatment parameters are valid, FALSE if not + *************************************************************************/ BOOL validateAndSetTreatmentParameters( MESSAGE_T *message ) { BOOL paramsAreInvalid = TRUE; @@ -275,15 +278,18 @@ return result; } + /*********************************************************************//** * @brief - * The validateAndSetUFVolume function validates the UF volume received - * from the UI. - * @details Inputs: message – UF volume validation message. - * @details Outputs: Applies UF limits, evaluates dependent constraints, - * and sends accept / reject result back to the UI. - * @return TRUE if the UF volume is valid, FALSE otherwise. - **************************************************************************/ + * The validateAndSetUFVolume function validates received ultrafiltration + * volume treatment parameter. + * @details \b Message \b Sent: MSG_ID_TD_RESP_ULTRAFILTRATION_VOLUME_TO_VALIDATE + * @details \b Inputs: none + * @details \b Outputs: none + * @param message set message from UI which includes the user set ultrafiltration + * volume (in mL). + * @return TRUE if received UF volume parameter is valid, FALSE if not + *************************************************************************/ BOOL validateAndSetUFVolume( MESSAGE_T *message ) { BOOL accepted = FALSE; @@ -338,13 +344,15 @@ /*********************************************************************//** * @brief - * The signalUserConfirmTreatmentParameters function handles user - * confirmation or rejection of Treatment Parameters (Rx). - * @details Inputs: message – UI confirm / reject Treatment Parameters message. - * @details Outputs: Updates local confirmation / rejection flags used by - * ModePreTreat to advance the Confirm Rx step. - * @return TRUE if the message was valid and processed, FALSE otherwise. - **************************************************************************/ + * The signalUserConfirmationOfTreatmentParameters function sets the user + * confirmation flag signaling user has confirmed or rejected treatment + * parameters. + * @details \b Inputs: none + * @details \b Outputs: treatParamsConfirmed, treatParamsRejected + * @param message confirmation message from UI which includes the user + * confirmation or rejection. + * @return TRUE if confirmation/rejection accepted, FALSE if not + *************************************************************************/ BOOL signalUserConfirmTreatmentParameters( MESSAGE_T *message ) { BOOL result = FALSE;