Index: firmware/App/Controllers/Buttons.h =================================================================== diff -u -rde5a0d43bdef611d963d11855bc958a8d8899a09 -r5eda37efda2d771de4f5cfb509adf05621a290c3 --- firmware/App/Controllers/Buttons.h (.../Buttons.h) (revision de5a0d43bdef611d963d11855bc958a8d8899a09) +++ firmware/App/Controllers/Buttons.h (.../Buttons.h) (revision 5eda37efda2d771de4f5cfb509adf05621a290c3) @@ -20,13 +20,22 @@ #include "HDCommon.h" +/** + * @defgroup Buttons Buttons + * @brief The Buttons module monitors and manages the off and stop buttons. + * + * @addtogroup Buttons + * @{ + */ + // ********** public definitions ********** - + +/// Enumeration of hardware button states. typedef enum Button_States { - BUTTON_STATE_RELEASED = 0, - BUTTON_STATE_PRESSED, - NUM_OF_BUTTON_STATES + BUTTON_STATE_RELEASED = 0, ///< Button is in the released state + BUTTON_STATE_PRESSED, ///< Button is in the pressed state + NUM_OF_BUTTON_STATES ///< Number of button states } BUTTON_STATE_T; // ********** public function prototypes ********** @@ -40,9 +49,11 @@ DATA_GET_PROTOTYPE( BUTTON_STATE_T, getOffButtonState ); DATA_GET_PROTOTYPE( BUTTON_STATE_T, getStopButtonState ); -BOOL testSetOffButtonStateOverride( BUTTON_STATE_T value ); +BOOL testSetOffButtonStateOverride( U32 value ); BOOL testResetOffButtonStateOverride( void ); -BOOL testSetStopButtonStateOverride( BUTTON_STATE_T value ); +BOOL testSetStopButtonStateOverride( U32 value ); BOOL testResetStopButtonStateOverride( void ); +/**@}*/ + #endif