Index: firmware/App/Modes/ModeDrain.h =================================================================== diff -u -rb64c49fdcf2b6d95e61e63f8e258c4e600935bbd -rc48a99d2d1c852adcc986253b6c420a90dab7bfe --- firmware/App/Modes/ModeDrain.h (.../ModeDrain.h) (revision b64c49fdcf2b6d95e61e63f8e258c4e600935bbd) +++ firmware/App/Modes/ModeDrain.h (.../ModeDrain.h) (revision c48a99d2d1c852adcc986253b6c420a90dab7bfe) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -8,7 +8,7 @@ * @file ModeDrain.h * * @date 19-Sep-2019 - * @author L. Baloa + * @author S. Nash * * @brief Header file for Drain Mode. * @@ -19,10 +19,21 @@ #include "DGCommon.h" +/** + * @defgroup DrainMode DrainMode + * @brief Drain mode module. + * Manages drain mode functions via a state machine. + * + * @addtogroup DrainMode + * @{ + */ + // ********** private function prototypes ********** void initDrainMode( void ); // initialize this module void transitionToDrainMode( void ); // prepares for transition to operating parameters mode void execDrainMode( void ); // execute the drain mode state machine +/**@}*/ + #endif