Index: firmware/App/Services/StateServices/TubeSetInstall.h =================================================================== diff -u -r0b025cea0b0f290ea44714a8fae6d71ea05088b9 -r4ea39ac34ede5011de1954b7c58761df25120fcf --- firmware/App/Services/StateServices/TubeSetInstall.h (.../TubeSetInstall.h) (revision 0b025cea0b0f290ea44714a8fae6d71ea05088b9) +++ firmware/App/Services/StateServices/TubeSetInstall.h (.../TubeSetInstall.h) (revision 4ea39ac34ede5011de1954b7c58761df25120fcf) @@ -32,29 +32,29 @@ // ********** public definitions ********** -///< Enumeration of Tube Set install sub-states. +/// Enumeration of Tube Set install sub-states. enum Tube_Set_Install_States { - TUBE_SET_INSTALL_STATE_AWAIT_TUBE_SET_CONFIRMATION = 0, // Awaiting user confirmation that tubeset is placed. - TUBE_SET_INSTALL_STATE_AWAIT_BP_DOOR_CLOSE, // Waiting for blood pump door to be closed. - TUBE_SET_INSTALL_STATE_AUTO_LOAD, // Auto-Load the tubeset state - TUBE_SET_INSTALL_STATE_AUTO_LOAD_BACK_OFF, // Auto-Load Back-off state - TUBE_SET_INSTALL_STATE_COMPLETE, // Install state complete - NUM_OF_TUBE_SET_INSTALL_SUB_STATES, // Num of install sub-states + TUBE_SET_INSTALL_STATE_AWAIT_TUBE_SET_CONFIRMATION = 0, ///< Awaiting user confirmation that tubeset is placed. + TUBE_SET_INSTALL_STATE_AWAIT_BP_DOOR_CLOSE, ///< Waiting for blood pump door to be closed. + TUBE_SET_INSTALL_STATE_AUTO_LOAD, ///< Auto-Load the tubeset state + TUBE_SET_INSTALL_STATE_AUTO_LOAD_BACK_OFF, ///< Auto-Load Back-off state + TUBE_SET_INSTALL_STATE_COMPLETE, ///< Install state complete + NUM_OF_TUBE_SET_INSTALL_SUB_STATES, ///< Num of install sub-states }; -///< Type for tube set install states enumeration +/// Type for tube set install states enumeration typedef enum Tube_Set_Install_States TUBE_SET_INSTALL_STATE_T; // ********** public function prototypes ********** -void initTubeSetInstall( void ); // Initialize this service -void execTubeSetInstall( void ); // Execute the service state machine (call from ModePreTreat and ModeTreatment) +void initTubeSetInstall( void ); ///< Initialize this service +void execTubeSetInstall( void ); ///< Execute the service state machine (call from ModePreTreat and ModeTreatment) -BOOL isTubeSetInstallComplete( void ); // Returns True once auto-load finished successfully -BOOL handleAutoLoadRequest( MESSAGE_T *message ); // Handle UI auto-load confirmation request +BOOL isTubeSetInstallComplete( void ); ///< Returns True once auto-load finished successfully +BOOL handleAutoLoadRequest( MESSAGE_T *message ); ///< Handle UI auto-load confirmation request -void setTubeSetType( TUBE_SET_TYPE_T type ); // Set the current installed tube set type -TUBE_SET_TYPE_T getTubeSetType( void ); // Get the current installed tube set type +void setTubeSetType( TUBE_SET_TYPE_T type ); ///< Set the current installed tube set type +TUBE_SET_TYPE_T getTubeSetType( void ); ///< Get the current installed tube set type /**@}*/