Index: firmware/App/Modes/TreatmentStop.h =================================================================== diff -u -r07a5add2dff254f7be3699e4efac2b99d3554847 -r8e7158d8231435496fcf1d5649e51babf859ccc7 --- firmware/App/Modes/TreatmentStop.h (.../TreatmentStop.h) (revision 07a5add2dff254f7be3699e4efac2b99d3554847) +++ firmware/App/Modes/TreatmentStop.h (.../TreatmentStop.h) (revision 8e7158d8231435496fcf1d5649e51babf859ccc7) @@ -1,26 +1,40 @@ /************************************************************************** - * - * Copyright (c) 2020 Diality Inc. - All Rights Reserved. - * - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN - * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. - * - * @file TreatmentStop.h - * - * @date 15-Jan-2020 - * @author S. Nash - * - * @brief Header file for Treatment Stop sub-mode. - * - **************************************************************************/ +* +* Copyright (c) 2019-2021 Diality Inc. - All Rights Reserved. +* +* THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN +* WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. +* +* @file TreatmentStop.h +* +* @author (last) Sean Nash +* @date (last) 29-May-2020 +* +* @author (original) Sean +* @date (original) 15-Jan-2020 +* +***************************************************************************/ #ifndef __TREATMENT_STOP_H__ #define __TREATMENT_STOP_H__ +#include "HDCommon.h" +#include "HDDefs.h" + +/** + * @defgroup TreatmentStop TreatmentStop + * @brief Treatment stop sub-mode of treatment mode. + * + * @addtogroup TreatmentStop + * @{ + */ + // ********** private function prototypes ********** -void initTreatmentStop( void ); // initialize this module -void transitionToTreatmentStop( void ); // prepares for transition to treatment stop sub-mode -void execTreatmentStop( void ); // execute the treatment stop sub-mode state machine (call from ModeTreatment) +void initTreatmentStop( void ); +void transitionToTreatmentStop( void ); +void execTreatmentStop( void ); +/**@}*/ + #endif