Index: firmware/App/Modes/ModeTreatmentParams.c =================================================================== diff -u -rd9d085cdca67200ecddbdfbc75c489e704b23081 -r37a8a58b766a496b39241dd7ae46dc10dbda35e4 --- firmware/App/Modes/ModeTreatmentParams.c (.../ModeTreatmentParams.c) (revision d9d085cdca67200ecddbdfbc75c489e704b23081) +++ firmware/App/Modes/ModeTreatmentParams.c (.../ModeTreatmentParams.c) (revision 37a8a58b766a496b39241dd7ae46dc10dbda35e4) @@ -101,9 +101,8 @@ /*********************************************************************//** * @brief * The initOpParamsMode function initializes the Operating Parameters Mode module. - * @details - * Inputs : none - * Outputs : Operating Parameters Mode module initialized. + * @details Inputs: none + * @details Outputs: Operating Parameters Mode module initialized. * @return none *************************************************************************/ void initTreatParamsMode( void ) @@ -115,9 +114,8 @@ * @brief * The transitionToOpParamsMode function prepares for transition to operating * parameters mode. - * @details - * Inputs : none - * Outputs : Treatment Parameters mode reset prior to starting + * @details Inputs: none + * @details Outputs: Treatment Parameters mode reset prior to starting * @return none *************************************************************************/ void transitionToTreatParamsMode( void ) @@ -142,9 +140,8 @@ * @brief * The resetAllTreatmentParameters function resets treatment parameters * to default values. - * @details - * Inputs : none - * Outputs : All treatment parameters reset to default values. + * @details Inputs: none + * @details Outputs: All treatment parameters reset to default values. * @return none *************************************************************************/ static void resetAllTreatmentParameters( void ) @@ -178,9 +175,8 @@ * @brief * The signalUserConfirmationOfTreatmentParameters function sets the user * confirmation flag signaling user has confirmed treatment parameters. - * @details - * Inputs : none - * Outputs : treatParamsConfirmed + * @details Inputs: none + * @details Outputs: treatParamsConfirmed * @return TRUE if confirmation accepted, FALSE if not *************************************************************************/ BOOL signalUserConfirmationOfTreatmentParameters( void ) @@ -200,9 +196,8 @@ * @brief * The signalUserCancelTreatment function sets the cancelled treatment * flag signaling the user has cancelled the treatment. - * @details - * Inputs : none - * Outputs : treatmentCancelled + * @details Inputs: none + * @details Outputs: treatmentCancelled * @return TRUE if cancel accepted, FALSE if not *************************************************************************/ BOOL signalUserCancelTreatment( void ) @@ -222,9 +217,8 @@ /*********************************************************************//** * @brief * The execFaultMode function executes the Operating Parameters Mode state machine. - * @details - * Inputs : treatParamsState - * Outputs : treatParamsState + * @details Inputs: treatParamsState + * @details Outputs: treatParamsState * @return current state (sub-mode) *************************************************************************/ U32 execTreatParamsMode( void ) @@ -268,9 +262,8 @@ * @brief * The handleWaitForUI2SendState function handles the wait for UI to send * treatment parameters state of treatment parameters mode. - * @details - * Inputs : - * Outputs : + * @details Inputs: + * @details Outputs: * @return current state (sub-mode) *************************************************************************/ static HD_TREATMENT_PARAMS_MODE_STATE_T handleWaitForUI2SendState( void ) @@ -299,9 +292,8 @@ * @brief * The handleWaitForUI2ConfirmState function handles the wait for UI to send * user confirmation state of treatment parameters mode. - * @details - * Inputs : - * Outputs : + * @details Inputs: + * @details Outputs: * @return current state (sub-mode) *************************************************************************/ static HD_TREATMENT_PARAMS_MODE_STATE_T handleWaitForUI2ConfirmState( void ) @@ -350,9 +342,8 @@ * @brief * The validateAndSetTreatmentParameters function validates received * treatment parameters. - * @details - * Inputs : none - * Outputs : stagedParams[], response sent + * @details Inputs: none + * @details Outputs: stagedParams[], response sent * @param params payload record from treatment parameters message received from UI * @return TRUE if received treatment parameters are valid, FALSE if not *************************************************************************/ @@ -388,9 +379,8 @@ * @brief * The checkTreatmentParamsInRange function checks whether received * treatment parameters are in range. - * @details - * Inputs : stagedParams[] - * Outputs : reasons[] + * @details Inputs: stagedParams[] + * @details Outputs: reasons[] * @param reasons Pointer to array of reject reason codes for each parameter * @return TRUE if treatment parameters are in range, FALSE if not *************************************************************************/ @@ -418,9 +408,8 @@ * @brief * The checkTreatmentParamsDependencies function checks dependencies between * received treatment parameters. - * @details - * Inputs : stagedParams[] - * Outputs : reasons[] + * @details Inputs: stagedParams[] + * @details Outputs: reasons[] * @param reasons Pointer to array of reject reason codes for each parameter * @return TRUE if treatment parameter dependencies are ok, FALSE if not *************************************************************************/ @@ -472,9 +461,8 @@ * @brief * The isTreatmentParamInRange function determines whether a given treatment * parameter is in range. - * @details - * Inputs : treatParamsRanges[] - * Outputs : none + * @details Inputs: treatParamsRanges[] + * @details Outputs: none * @param param ID of parameter to check range for * @param value value of parameter to check range for * @return TRUE if given treatment parameter is in range, FALSE if not @@ -520,9 +508,8 @@ * The extractTreatmentParamsFromPayload function extracts the individual * treatment parameters received from the UI into a staging array where * they will be validated and stay until user confirms them. - * @details - * Inputs : none - * Outputs : stagedParams[] + * @details Inputs: none + * @details Outputs: stagedParams[] * @param payload message payload record containing received treatment parameters * @return none *************************************************************************/ @@ -537,9 +524,8 @@ * The sendTreatmentParamsResponse function responds to the treatment parameters * received from the UI. An over-all ok/rejected flag as well as individual reject * reason codes for each parameter are provided back to the UI. - * @details - * Inputs : none - * Outputs : Response to treatment parameters message constructed and sent. + * @details Inputs: none + * @details Outputs: Response to treatment parameters message constructed and sent. * @param valid 1 if valid, 0 if not * @param reasons array of reject reason codes for each parameter (0=not rejected) * @return none @@ -557,9 +543,8 @@ * @brief * The setTreatmentParameterU32 function sets a given unsigned integer * treatment parameter to a given value. - * @details - * Inputs : treatmentParameters[] - * Outputs : treatmentParameters[] + * @details Inputs: treatmentParameters[] + * @details Outputs: treatmentParameters[] * @param param ID of treatment parameter to set unsigned integer value for * @param value unsigned integer value to assign to given treatment parameter * @return TRUE if set was successful, FALSE if not @@ -588,9 +573,8 @@ * @brief * The setTreatmentParameterS32 function sets a given signed integer treatment * parameter to a given value. - * @details - * Inputs : treatmentParameters[] - * Outputs : treatmentParameters[] + * @details Inputs: treatmentParameters[] + * @details Outputs: treatmentParameters[] * @param param ID of treatment parameter to set signed integer value for * @param value signed integer value to assign to given treatment parameter * @return TRUE if set was successful, FALSE if not @@ -619,9 +603,8 @@ * @brief * The setTreatmentParameterF32 sets a given floating point treatment parameter * to a given value. - * @details - * Inputs : treatmentParameters[] - * Outputs : treatmentParameters[] + * @details Inputs: treatmentParameters[] + * @details Outputs: treatmentParameters[] * @param param ID of treatment parameter to set floating point value for * @param value floating point value to assign to given treatment parameter * @return TRUE if set was successful, FALSE if not @@ -650,9 +633,8 @@ * @brief * The getTreatmentParameterU32 function gets the value of a given unsigned * integer treatment parameter. - * @details - * Inputs : treatmentParameters[] - * Outputs : none + * @details Inputs: treatmentParameters[] + * @details Outputs: none * @param param ID of treatment parameter to get unsigned integer value for * @return value of given unsigned integer treatment parameter *************************************************************************/ @@ -679,9 +661,8 @@ * @brief * The getTreatmentParameterS32 function gets the value of a given signed * integer treatment parameter. - * @details - * Inputs : treatmentParameters[] - * Outputs : none + * @details Inputs: treatmentParameters[] + * @details Outputs: none * @param param ID of treatment parameter to get signed integer value for * @return value of given signed integer treatment parameter *************************************************************************/ @@ -708,9 +689,8 @@ * @brief * The getTreatmentParameterF32 function gets the value of a given floating point * treatment parameter. - * @details - * Inputs : treatmentParameters[] - * Outputs : none + * @details Inputs: treatmentParameters[] + * @details Outputs: none * @param param ID of treatment parameter to get floating point value for * @return value of given floating point treatment parameter *************************************************************************/ @@ -743,9 +723,8 @@ * @brief * The testSetTreatmentParameterOverride function overrides the value of a * given treatment parameter. - * @details - * Inputs : none - * Outputs : treatment parameter set to given value + * @details Inputs: none + * @details Outputs: treatment parameter set to given value * @param param ID of treatment parameter to set value of * @param value value to set for given treatment parameter * @return TRUE if override successful, FALSE if not