Index: firmware/App/Modes/ModeFlush.h =================================================================== diff -u -rb64c49fdcf2b6d95e61e63f8e258c4e600935bbd -rc48a99d2d1c852adcc986253b6c420a90dab7bfe --- firmware/App/Modes/ModeFlush.h (.../ModeFlush.h) (revision b64c49fdcf2b6d95e61e63f8e258c4e600935bbd) +++ firmware/App/Modes/ModeFlush.h (.../ModeFlush.h) (revision c48a99d2d1c852adcc986253b6c420a90dab7bfe) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -8,7 +8,7 @@ * @file ModeFlush.h * * @date 20-Dec-2019 - * @author L. Baloa + * @author S. Nash * * @brief Header file for Flush Mode. * @@ -19,10 +19,21 @@ #include "DGCommon.h" +/** + * @defgroup FlushMode FlushMode + * @brief Flush mode module. Manages the state machine for the + * flush mode. + * + * @addtogroup FlushMode + * @{ + */ + // ********** private function prototypes ********** void initFlushMode( void ); // initialize this module void transitionToFlushMode( void ); // prepares for transition to pre-treatment mode void execFlushMode( void ); // execute the pre-treatment mode state machine (call from OperationModes) +/**@}*/ + #endif