diff options
| author | hathach <[email protected]> | 2014-03-16 22:20:33 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2014-03-16 22:20:33 +0700 |
| commit | d1d4ddd85626567ddd0369387276ccf9680673d6 (patch) | |
| tree | 7bded70898796d0219c2245f6dabe6bdfdb7fbac /tinyusb/osal | |
| parent | 18d577abfb3feb3c4eb2728661b6c508cdf37da0 (diff) | |
doxygen document
Diffstat (limited to 'tinyusb/osal')
| -rw-r--r-- | tinyusb/osal/osal.h | 13 | ||||
| -rw-r--r-- | tinyusb/osal/osal_cmsis_rtx.h | 9 | ||||
| -rw-r--r-- | tinyusb/osal/osal_freeRTOS.h | 12 | ||||
| -rw-r--r-- | tinyusb/osal/osal_none.h | 11 |
4 files changed, 20 insertions, 25 deletions
diff --git a/tinyusb/osal/osal.h b/tinyusb/osal/osal.h index d68bbf43b..4bb28c1fb 100644 --- a/tinyusb/osal/osal.h +++ b/tinyusb/osal/osal.h @@ -51,12 +51,8 @@ /** @} */
-/** \addtogroup Port Port
- * @{
- * \defgroup Port_OSAL OS Abstraction Layer (OSAL)
- * @{
- */
-
+/** \defgroup Group_OSAL OS Abstraction Layer (OSAL)
+ * @{ */
#ifdef __cplusplus
extern "C" {
@@ -68,6 +64,7 @@ #if TUSB_CFG_OS == TUSB_OS_NONE
#include "osal_none.h"
+
#else
#define OSAL_VAR
#define OSAL_TASK_FUNCTION(task_func) void task_func
@@ -111,7 +108,8 @@ #endif
#endif
-#else // OSAL API for cmock
+//------------- OSAL API for cmock -------------//
+#else
#define OSAL_VAR
#include "osal_common.h"
@@ -232,6 +230,5 @@ uint32_t osal_tick_get(void); #endif
/** @} */
-/** @} */
#endif /* _TUSB_OSAL_H_ */
diff --git a/tinyusb/osal/osal_cmsis_rtx.h b/tinyusb/osal/osal_cmsis_rtx.h index 74682e3ee..c65dc911c 100644 --- a/tinyusb/osal/osal_cmsis_rtx.h +++ b/tinyusb/osal/osal_cmsis_rtx.h @@ -36,12 +36,10 @@ */ /**************************************************************************/ -/** \ingroup TBD - * \defgroup TBD - * \brief TBD - * +/** \ingroup Group_OSAL * @{ - */ + * \defgroup Group_CMSISRTX CMSIS-RTOS RTX + * @{ */ #ifndef _TUSB_OSAL_CMSIS_RTX_H_ #define _TUSB_OSAL_CMSIS_RTX_H_ @@ -211,3 +209,4 @@ static inline void osal_queue_flush(osal_queue_handle_t const queue_hdl) #endif /* _TUSB_OSAL_CMSIS_RTX_H_ */ /** @} */ +/** @} */ diff --git a/tinyusb/osal/osal_freeRTOS.h b/tinyusb/osal/osal_freeRTOS.h index 42e2c4075..942a0ea5b 100644 --- a/tinyusb/osal/osal_freeRTOS.h +++ b/tinyusb/osal/osal_freeRTOS.h @@ -36,12 +36,10 @@ */ /**************************************************************************/ -/** \ingroup TBD - * \defgroup TBD - * \brief TBD - * - * @{ - */ +/** \ingroup Group_OSAL + * @{ + * \defgroup Group_FreeRTOS FreeRTOS + * @{ */ #ifndef _TUSB_OSAL_FREERTOS_H_ #define _TUSB_OSAL_FREERTOS_H_ @@ -201,3 +199,5 @@ static inline void osal_queue_flush(osal_queue_handle_t const queue_hdl) #endif /* _TUSB_OSAL_FREERTOS_H_ */ /** @} */ +/** @} */ + diff --git a/tinyusb/osal/osal_none.h b/tinyusb/osal/osal_none.h index 4f59361b5..739d1864d 100644 --- a/tinyusb/osal/osal_none.h +++ b/tinyusb/osal/osal_none.h @@ -36,12 +36,10 @@ */
/**************************************************************************/
-/** \ingroup TBD
- * \defgroup TBD
- * \brief TBD
- *
- * @{
- */
+/** \addtogroup Group_OSAL
+ * @{
+ * \defgroup Group_OSNone None OS
+ * @{ */
#ifndef _TUSB_OSAL_NONE_H_
#define _TUSB_OSAL_NONE_H_
@@ -337,3 +335,4 @@ static inline void osal_queue_flush(osal_queue_handle_t const queue_hdl) #endif /* _TUSB_OSAL_NONE_H_ */
/** @} */
+/** @} */
|