Index: firmware/App/Controllers/AlarmLamp.h =================================================================== diff -u -rde5a0d43bdef611d963d11855bc958a8d8899a09 -r4459be59bdc2896b44bcf6cd42d2762190e23c16 --- firmware/App/Controllers/AlarmLamp.h (.../AlarmLamp.h) (revision de5a0d43bdef611d963d11855bc958a8d8899a09) +++ firmware/App/Controllers/AlarmLamp.h (.../AlarmLamp.h) (revision 4459be59bdc2896b44bcf6cd42d2762190e23c16) @@ -20,18 +20,27 @@ #include "HDCommon.h" +/** + * @defgroup AlarmLamp AlarmLamp + * @brief The Alarm Lamp module manages the state of the alarm lamp. + * + * @addtogroup AlarmLamp + * @{ + */ + // ********** public definitions ********** - + +/// Enumeration of alarm lamp patterns. typedef enum LampPatternEnum { - LAMP_PATTERN_OFF = 0, - LAMP_PATTERN_OK, - LAMP_PATTERN_FAULT, - LAMP_PATTERN_HIGH_ALARM, - LAMP_PATTERN_MED_ALARM, - LAMP_PATTERN_LOW_ALARM, - LAMP_PATTERN_MANUAL, - NUM_OF_LAMP_PATTERNS + LAMP_PATTERN_OFF = 0, ///< Alarm lamp pattern where lamp is off + LAMP_PATTERN_OK, ///< Alarm lamp pattern for ok state + LAMP_PATTERN_FAULT, ///< Alarm lamp pattern for fault state + LAMP_PATTERN_HIGH_ALARM, ///< Alarm lamp pattern for high priority alarm state + LAMP_PATTERN_MED_ALARM, ///< Alarm lamp pattern for medium priority alarm state + LAMP_PATTERN_LOW_ALARM, ///< Alarm lamp pattern for low priority alarm state + LAMP_PATTERN_MANUAL, ///< Alarm lamp pattern is managed manually in the state + NUM_OF_LAMP_PATTERNS ///< Number of alarm lamp patterns } LAMP_PATTERN_T; // ********** public function prototypes ********** @@ -43,7 +52,9 @@ DATA_GET_PROTOTYPE( LAMP_PATTERN_T, getCurrentAlarmLampPattern ); -BOOL testSetCurrentLampPatternOverride( LAMP_PATTERN_T value ); +BOOL testSetCurrentLampPatternOverride( U32 value ); BOOL testResetCurrentLampPatternOverride( void ); +/**@}*/ + #endif