Index: DGModes.h =================================================================== diff -u -r25fdafe7dd34b2c7b133b0d9fa0287388e64334e -rd198c3b36ee7b8daba8ffa9cba7906bad79c82bd --- DGModes.h (.../DGModes.h) (revision 25fdafe7dd34b2c7b133b0d9fa0287388e64334e) +++ DGModes.h (.../DGModes.h) (revision d198c3b36ee7b8daba8ffa9cba7906bad79c82bd) @@ -19,17 +19,13 @@ #include "Common.h" +// ********** public definitions ********** + /** - * @defgroup DGModes DGModes - * @brief DGModes header. Provides enumeration lists of all DG - * operation modes and their sub-modes (states).. - * - * @addtogroup DGModes + * @addtogroup DGOperationModes * @{ */ -// ********** public definitions ********** - /// Enumeration of operation modes. These are in order of priority (highest to lowest). typedef enum DG_Op_Modes { @@ -48,6 +44,13 @@ NUM_OF_DG_MODES } DG_OP_MODE_T; +/**@}*/ + +/** + * @addtogroup DGInitAndPOSTMode + * @{ + */ + /// Enumeration of init & POST mode states. typedef enum DG_POST_States { @@ -59,20 +62,41 @@ NUM_OF_DG_POST_STATES ///< Number of initialize & POST mode states. } DG_POST_STATE_T; +/**@}*/ + +/** + * @addtogroup DGFaultMode + * @{ + */ + /// Enumeration of fault mode states. typedef enum DG_Fault_States { DG_FAULT_STATE_START = 0, ///< Start solo fault state. NUM_OF_DG_FAULT_STATES ///< Number of fault mode states. } DG_FAULT_STATE_T; +/**@}*/ + +/** + * @addtogroup DGSoloStandbyMode + * @{ + */ + /// Enumeration of solo standby mode states. typedef enum DG_Solo_States { DG_SOLO_STANDBY_STATE_START = 0, ///< Start solo standby mode state. NUM_OF_DG_SOLO_STANDBY_STATES ///< Number of solo standby mode states. } DG_SOLO_STANDBY_STATE_T; +/**@}*/ + +/** + * @addtogroup DGStandbyMode + * @{ + */ + /// Enumeration of standby mode states. typedef enum DG_Standby_Mode_States { @@ -82,6 +106,13 @@ NUM_OF_DG_STANDBY_MODE_STATES ///< Number of standby mode states. } DG_STANDBY_MODE_STATE_T; +/**@}*/ + +/** + * @addtogroup DGRecirculateMode + * @{ + */ + /// Enumeration of re-circulation mode states. typedef enum DG_Recirculate_Mode_States { @@ -92,6 +123,13 @@ NUM_OF_DG_RECIRCULATE_MODE_STATES ///< Number of fill mode states. } DG_RECIRCULATE_MODE_STATE_T; +/**@}*/ + +/** + * @addtogroup DGFillMode + * @{ + */ + /// Enumeration of fill mode states. typedef enum DG_Fill_Mode_States { @@ -101,6 +139,13 @@ NUM_OF_DG_FILL_MODE_STATES ///< Number of fill mode states. } DG_FILL_MODE_STATE_T; +/**@}*/ + +/** + * @addtogroup DGDrainMode + * @{ + */ + /// Enumeration of drain mode states. typedef enum DG_Drain_States { @@ -109,27 +154,55 @@ NUM_OF_DG_DRAIN_STATES ///< Number of drain mode states. } DG_DRAIN_STATE_T; +/**@}*/ + +/** + * @addtogroup DGFlushMode + * @{ + */ + /// Enumeration of flush mode states. typedef enum DG_Flush_States { DG_FLUSH_STATE_START = 0, ///< Start flush mode state. NUM_OF_DG_FLUSH_STATES ///< Number of flush mode states. } DG_FLUSH_STATE_T; +/**@}*/ + +/** + * @addtogroup DGHeatDisinfectMode + * @{ + */ + /// Enumeration of heat disinfection mode states. typedef enum DG_Heat_States { DG_HEAT_DISINFECT_STATE_START = 0, ///< Start heat disinfect mode state. NUM_OF_DG_HEAT_DISINFECT_STATES ///< Number of heat disinfect mode states. } DG_HEAT_DISINFECT_STATE_T; +/**@}*/ + +/** + * @addtogroup DGChemicalDisinfectMode + * @{ + */ + /// Enumeration of chem. disinfect mode states. typedef enum DG_Chem_States { DG_CHEM_DISINFECT_STATE_START = 0, ///< Start chemical disinfect mode state. NUM_OF_DG_CHEM_DISINFECT_STATES ///< Number of chemical disinfect mode states. } DG_CHEM_DISINFECT_STATE_T; +/**@}*/ + +/** + * @addtogroup DGServiceMode + * @{ + */ + /// Enumeration of service mode states. typedef enum DG_Service_States {