Index: TestSupport.h =================================================================== diff -u -re8828d66e4a76e0590c3f06b7f6235f33df64e80 -r2aff3fd80d5ba16badceba146c2d3b15561cae04 --- TestSupport.h (.../TestSupport.h) (revision e8828d66e4a76e0590c3f06b7f6235f33df64e80) +++ TestSupport.h (.../TestSupport.h) (revision 2aff3fd80d5ba16badceba146c2d3b15561cae04) @@ -18,56 +18,70 @@ #ifndef __TEST_SUPPORT_H__ #define __TEST_SUPPORT_H__ +/** + * @defgroup TestSupport TestSupport + * @brief Test support header file. Contains the structures and macros for override operations. + * + * @addtogroup TestSupport + * @{ + */ + // ***************************** OVERRIDE DEFINITIONS & MACROS ************************************* -#define OVERRIDE_KEY 0xCCC33C33 -#define OVERRIDE_RESET 0x00000000 +#define OVERRIDE_KEY 0xCCC33C33 ///< Override key +#define OVERRIDE_RESET 0x00000000 ///< Override reset #pragma pack(push,1) +/// Test override payload type union. typedef union { - U32 u32; - F32 f32; + U32 u32; ///< U32 + F32 f32; ///< F32 } TEST_OVERRIDE_PAYLOAD_TYPE_T; +/// Test override payload type structure. typedef struct { - BOOL reset; - TEST_OVERRIDE_PAYLOAD_TYPE_T state; + BOOL reset; ///< Reset (bool) + TEST_OVERRIDE_PAYLOAD_TYPE_T state; ///< Test override payload } TEST_OVERRIDE_PAYLOAD_T; +/// Test override array payload structure. typedef struct { - BOOL reset; - TEST_OVERRIDE_PAYLOAD_TYPE_T state; - U32 index; + BOOL reset; ///< Reset (bool) + TEST_OVERRIDE_PAYLOAD_TYPE_T state; ///< Test override array payload + U32 index; ///< Index } TEST_OVERRIDE_ARRAY_PAYLOAD_T; #pragma pack(pop) -typedef struct \ -{ \ - U32 data; \ - U32 ovInitData; \ - U32 ovData; \ - U32 override; \ +/// Override U32 structure. +typedef struct +{ + U32 data; ///< Data + U32 ovInitData; ///< Override init data + U32 ovData; ///< Override data + U32 override; ///< Override } OVERRIDE_U32_T; -typedef struct \ -{ \ - S32 data; \ - S32 ovInitData; \ - S32 ovData; \ - U32 override; \ +/// Override S32 structure. +typedef struct +{ + S32 data; ///< Data + S32 ovInitData; ///< Override init data + S32 ovData; ///< Override data + U32 override; ///< Override } OVERRIDE_S32_T; -typedef struct \ -{ \ - F32 data; \ - F32 ovInitData; \ - F32 ovData; \ - U32 override; \ +/// Override F32 structure. +typedef struct +{ + F32 data; ///< Data + F32 ovInitData; ///< Override init data + F32 ovData; ///< Overrode data + U32 override; ///< Override } OVERRIDE_F32_T; // DATA_DECL - declares an overrideable data variable @@ -354,4 +368,6 @@ sendTestAckResponseMsg( (MSG_ID_T)message->hdr.msgID, result ); \ } +/**@}*/ + #endif