Index: firmware/App/Modes/ModeTreatment.h =================================================================== diff -u -r521a0569bf3097e9f7075d9c0e99dca9af3e6410 -re0e66d4c302c2aa43951ca316689ed4debbff1fb --- firmware/App/Modes/ModeTreatment.h (.../ModeTreatment.h) (revision 521a0569bf3097e9f7075d9c0e99dca9af3e6410) +++ firmware/App/Modes/ModeTreatment.h (.../ModeTreatment.h) (revision e0e66d4c302c2aa43951ca316689ed4debbff1fb) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -20,6 +20,14 @@ #include "HDCommon.h" #include "Dialysis.h" +/** + * @defgroup TreatmentMode TreatmentMode + * @brief TreatmentMode module. + * + * @addtogroup TreatmentMode + * @{ + */ + // ********** public definitions ********** /// Sub-mode states while in treatment mode @@ -36,19 +44,21 @@ TREATMENT_RECIRC_STOP_STATE, ///< Recirculate stopped. Blood pump off. Blood lines open. Waiting for patient to unshunt and connect and resume treatment. TREATMENT_DIALYSIS_END_STATE, ///< Dialysis has ended. Blood pump slowed. Dialyzer is bypassed. Dialysate is recirculated. User can rinseback. TREATMENT_END_STATE, ///< Treatment has ended. All pumps off. Dialyzer is bypassed. Blood lines are closed. User to disconnect. - NUM_OF_TREATMENT_STATES ///< # of treatment states (sub-modes). + NUM_OF_TREATMENT_STATES ///< Number of treatment states (sub-modes). } TREATMENT_STATE_T; // ********** private function prototypes ********** -void initTreatmentMode( void ); // initialize this module -void transitionToTreatmentMode( void ); // prepares for transition to treatment mode -void execTreatmentMode( void ); // execute the treatment mode state machine (call from OperationModes) +void initTreatmentMode( void ); // initialize this module +void transitionToTreatmentMode( void ); // prepares for transition to treatment mode +void execTreatmentMode( void ); // execute the treatment mode state machine (call from OperationModes) TREATMENT_STATE_T getTreatmentState( void ); BOOL verifyTreatmentDurationSettingChange( U32 treatmentTime ); BOOL verifyUFSettingsChange( F32 uFVolume, UF_ADJ_T adjustment ); BOOL verifyUFSettingsConfirmation( BOOL confirmed, F32 uFVolume, U32 treatmentTime, F32 uFRate ); +/**@}*/ + #endif