Index: firmware/App/Modes/ModeStandby.c =================================================================== diff -u -r4fa5628781e2b420cad6afc42a4b754dd484b997 -rf43eb1e9e0803776ec7420b16e1db8760b020bd9 --- firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision 4fa5628781e2b420cad6afc42a4b754dd484b997) +++ firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision f43eb1e9e0803776ec7420b16e1db8760b020bd9) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -18,24 +18,30 @@ #include "ModeStandby.h" #include "CPLD.h" +/** + * @addtogroup StandbyMode + * @{ + */ + // ********** private definitions ********** +/// Enumeration of standby mode states. typedef enum Standby_Mode_States { - STANDBY_MODE_STATE_START = 0, - STANDBY_MODE_STATE_IDLE, - NUM_OF_STANDBY_MODE_STATES + STANDBY_MODE_STATE_START = 0, ///< Start standby mode state. + STANDBY_MODE_STATE_IDLE, ///< Idle standby mode state. + NUM_OF_STANDBY_MODE_STATES ///< Number of standby mode states. } STANDBY_MODE_STATE_T; // ********** private data ********** -static STANDBY_MODE_STATE_T standbyState = STANDBY_MODE_STATE_START; +static STANDBY_MODE_STATE_T standbyState = STANDBY_MODE_STATE_START; ///< Currently active standby state. // ********** private function prototypes ********** STANDBY_MODE_STATE_T handleStandbyIdleState( void ); -/************************************************************************* +/*********************************************************************//** * @brief initStandbyMode * The initStandbyMode function initializes the Standby Mode module. * @details @@ -48,7 +54,7 @@ { } -/************************************************************************* +/*********************************************************************//** * @brief transitionToStandbyMode * The transitionToStandbyMode function prepares for transition to standby mode. * @details @@ -63,7 +69,7 @@ standbyState = STANDBY_MODE_STATE_START; } -/************************************************************************* +/*********************************************************************//** * @brief execStandbyMode * The execStandbyMode function executes the Standby Mode state machine. * @details @@ -86,13 +92,13 @@ break; default: - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, 0, standbyState ) + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, 0, standbyState ) // TODO - add s/w fault enum to 1st data param standbyState = STANDBY_MODE_STATE_START; break; } } -/************************************************************************* +/*********************************************************************//** * @brief * The handleStandbyIdleState function executes the Idle state of the \n * Standby Mode state machine. @@ -116,3 +122,5 @@ return result; } + +/**@}*/