Merge with 5eed0471196ddd710647bb8cf83ad6e9aa189c61 (default branch)

[arc.git] / include / Std_Types.h

diff --git a/include/Std_Types.h b/include/Std_Types.h
index 9278b25cd0f90f29d8ee7676a9a23e25e2033667..fe7592cf03321af8470a720730c08514562ea579 100644 (file)
--- a/include/Std_Types.h
+++ b/include/Std_Types.h
@@ -13,6 +13,13 @@
  * for more details.
  * -------------------------------- Arctic Core ------------------------------*/
 
+
+/** @addtogroup General General
+ *  @{ */
+
+/** @file Std_Types.h
+ *  Definitions of General types.
+ */
 \r
 #ifndef _STD_TYPES_H\r
 #define _STD_TYPES_H\r
@@ -39,20 +46,20 @@ typedef struct {
        uint16 vendorID;\r
        uint16 moduleID;\r
        uint8  instanceID;\r
-       /* Vendor numbers */\r
-       uint8 sw_major_version;\r
-       uint8 sw_minor_version;\r
-       uint8 sw_patch_version;\r
-       /* Autosar spec. numbers */\r
-       uint8 ar_major_version;\r
-       uint8 ar_minor_version;\r
-       uint8 ar_patch_version;\r
+
+       uint8 sw_major_version;    /**< Vendor numbers */
+       uint8 sw_minor_version;    /**< Vendor numbers */
+       uint8 sw_patch_version;    /**< Vendor numbers */
+
+       uint8 ar_major_version;    /**< Autosar spec. numbers */
+       uint8 ar_minor_version;    /**< Autosar spec. numbers */
+       uint8 ar_patch_version;    /**< Autosar spec. numbers */
 } Std_VersionInfoType;\r
 \r
-/* make compare number... #if blabla > 10203  ( 1.2.3 ) */\r
+/** make compare number... #if version > 10203  ( 1.2.3 ) */
 #define STD_GET_VERSION (_major,_minor,_patch) (_major * 10000 + _minor * 100 + _patch)\r
 \r
-/* Non-standard macro */\r
+/** Create Std_VersionInfoType */
 #define STD_GET_VERSION_INFO(_vi,_module) \\r
        ((_vi)->vendorID =  _module ## _VENDOR_ID);\\r
        ((_vi)->moduleID = _module ## _MODULE_ID);\\r
@@ -69,34 +76,32 @@ typedef struct {
 #define STATUSTYPEDEFINED\r
 typedef enum {\r
        E_OK = 0,\r
-       /* STD OSEK */\r
-       E_OS_ACCESS = 1,\r
-       E_OS_CALLEVEL = 2,\r
-       E_OS_ID = 3,\r
-       E_OS_LIMIT = 4,\r
-       E_OS_NOFUNC = 5,\r
-       E_OS_RESOURCE = 6,\r
-       E_OS_STATE = 7,\r
-       E_OS_VALUE = 8,\r
-\r
-       /* AUTOSAR, see 7.10 */\r
-       E_OS_SERVICEID,\r
-       E_OS_RATE ,\r
-       E_OS_ILLEGAL_ADDRESS ,\r
-       E_OS_MISSINGEND ,\r
-       E_OS_DISABLEDINT ,\r
-       E_OS_STACKFAULT ,\r
-       E_OS_PROTECTION_MEMORY ,\r
-       E_OS_PROTECTION_TIME ,\r
-       E_OS_PROTECTION_LOCKED ,\r
-       E_OS_PROTECTION_EXCEPTION ,\r
-       E_OS_PROTECTION_RATE,\r
+       E_OS_ACCESS = 1,               /**< STD OSEK */
+       E_OS_CALLEVEL = 2,             /**< STD OSEK */
+       E_OS_ID = 3,                   /**< STD OSEK */
+       E_OS_LIMIT = 4,                /**< STD OSEK */
+       E_OS_NOFUNC = 5,               /**< STD OSEK */
+       E_OS_RESOURCE = 6,             /**< STD OSEK */
+       E_OS_STATE = 7,                /**< STD OSEK */
+       E_OS_VALUE = 8,                /**< STD OSEK */
+\r
+       E_OS_SERVICEID,                /**< AUTOSAR, see 7.10 */
+       E_OS_RATE ,                    /**< AUTOSAR, see 7.10 */
+       E_OS_ILLEGAL_ADDRESS ,         /**< AUTOSAR, see 7.10 */
+       E_OS_MISSINGEND ,              /**< AUTOSAR, see 7.10 */
+       E_OS_DISABLEDINT ,             /**< AUTOSAR, see 7.10 */
+       E_OS_STACKFAULT ,              /**< AUTOSAR, see 7.10 */
+       E_OS_PROTECTION_MEMORY ,       /**< AUTOSAR, see 7.10 */
+       E_OS_PROTECTION_TIME ,         /**< AUTOSAR, see 7.10 */
+       E_OS_PROTECTION_LOCKED ,       /**< AUTOSAR, see 7.10 */
+       E_OS_PROTECTION_EXCEPTION ,    /**< AUTOSAR, see 7.10 */
+       E_OS_PROTECTION_RATE,          /**< AUTOSAR, see 7.10 */
 \r
        /* COM.. TODO: move ?? */\r
        E_COM_ID,\r
 \r
 \r
-       /* Implementation specific */\r
+       /** Implementation specific */
        E_OS_SYS_APA,\r
 \r
        E_NOT_OK,\r
@@ -124,3 +129,4 @@ typedef unsigned char StatusType;
 \r
 \r
 #endif\r
+/** @} */