From d1d4ddd85626567ddd0369387276ccf9680673d6 Mon Sep 17 00:00:00 2001 From: hathach Date: Sun, 16 Mar 2014 22:20:33 +0700 Subject: doxygen document --- tinyusb/class/custom_class.h | 8 ++++---- tinyusb/class/hid_host.h | 2 +- tinyusb/class/msc.h | 3 +-- tinyusb/common/binary.h | 12 ++++++------ tinyusb/common/common.h | 7 ++----- tinyusb/common/timeout_timer.h | 19 +++++++------------ tinyusb/device/dcd.h | 9 +++------ tinyusb/device/dcd_lpc175x_6x.h | 2 +- tinyusb/device/usbd.h | 7 ++----- tinyusb/hal/hal.h | 8 +++----- tinyusb/host/ehci/ehci.h | 2 +- tinyusb/host/hcd.h | 11 ++++------- tinyusb/host/hub.h | 2 +- tinyusb/host/ohci/ohci.h | 5 ++--- tinyusb/host/usbh.h | 7 ++----- tinyusb/host/usbh_hcd.h | 13 +++---------- tinyusb/osal/osal.h | 13 +++++-------- tinyusb/osal/osal_cmsis_rtx.h | 9 ++++----- tinyusb/osal/osal_freeRTOS.h | 12 ++++++------ tinyusb/osal/osal_none.h | 11 +++++------ 20 files changed, 63 insertions(+), 99 deletions(-) (limited to 'tinyusb') diff --git a/tinyusb/class/custom_class.h b/tinyusb/class/custom_class.h index 6fe219e3c..0070e2d53 100644 --- a/tinyusb/class/custom_class.h +++ b/tinyusb/class/custom_class.h @@ -36,10 +36,9 @@ */ /**************************************************************************/ -/** \ingroup TBD - * \defgroup TBD - * \brief TBD - * +/** \addtogroup ClassDriver Class Driver + * @{ + * \defgroup Group_Custom Custom Class (not supported yet) * @{ */ @@ -89,3 +88,4 @@ void cush_close(uint8_t dev_addr); #endif /* _TUSB_CUSTOM_CLASS_H_ */ /** @} */ +/** @} */ diff --git a/tinyusb/class/hid_host.h b/tinyusb/class/hid_host.h index 9fb765e1d..5b47f8699 100644 --- a/tinyusb/class/hid_host.h +++ b/tinyusb/class/hid_host.h @@ -185,7 +185,7 @@ void tusbh_hid_mouse_unmounted_cb(uint8_t dev_addr); //--------------------------------------------------------------------+ // GENERIC Application API //--------------------------------------------------------------------+ -/** \addtogroup ClassDriver_HID_Generic Generic +/** \addtogroup ClassDriver_HID_Generic Generic (not supported yet) * @{ */ /** \defgroup Generic_Host Host diff --git a/tinyusb/class/msc.h b/tinyusb/class/msc.h index 2c6adb2d6..0183b3fa3 100644 --- a/tinyusb/class/msc.h +++ b/tinyusb/class/msc.h @@ -36,8 +36,7 @@ */ /**************************************************************************/ -/** - * \addtogroup ClassDriver Class Driver +/** \addtogroup ClassDriver Class Driver * @{ * \defgroup ClassDriver_MSC MassStorage (MSC) * @{ */ diff --git a/tinyusb/common/binary.h b/tinyusb/common/binary.h index 1c284890f..6beeb8595 100644 --- a/tinyusb/common/binary.h +++ b/tinyusb/common/binary.h @@ -36,12 +36,11 @@ */ /**************************************************************************/ -/** \ingroup TBD - * \defgroup TBD - * \brief TBD - * - * @{ - */ +/** \addtogroup Group_Common Common Files + * @{ + * \defgroup Group_Binary binary.h + * @{ */ + #ifndef _TUSB_BINARY_H_ #define _TUSB_BINARY_H_ @@ -132,3 +131,4 @@ static inline uint32_t bit_set_range(uint32_t value, uint8_t start, uint8_t end, #endif /* _TUSB_BINARY_H_ */ /** @} */ +/** @} */ diff --git a/tinyusb/common/common.h b/tinyusb/common/common.h index db4d72661..a24887b2d 100644 --- a/tinyusb/common/common.h +++ b/tinyusb/common/common.h @@ -36,13 +36,10 @@ */ /**************************************************************************/ -/** \defgroup Group_Common Common Files +/** \addtogroup Group_Common Common Files * @{ - * * \defgroup Group_CommonH common.h - * - * @{ - */ + * @{ */ #ifndef _TUSB_COMMON_H_ #define _TUSB_COMMON_H_ diff --git a/tinyusb/common/timeout_timer.h b/tinyusb/common/timeout_timer.h index 2a7161c72..b1919638d 100644 --- a/tinyusb/common/timeout_timer.h +++ b/tinyusb/common/timeout_timer.h @@ -36,18 +36,11 @@ */ /**************************************************************************/ -/** \file - * \brief TBD - * - * \note TBD - */ - -/** \ingroup TBD - * \defgroup TBD - * \brief TBD - * - * @{ - */ +/** \addtogroup Group_Common Common Files + * @{ + * \defgroup Group_TimeoutTimer timeout timer + * @{ */ + #ifndef _TUSB_TIMEOUT_TTIMER_H_ #define _TUSB_TIMEOUT_TTIMER_H_ @@ -83,3 +76,5 @@ static inline bool timeout_expired(timeout_timer_t* tt) #endif /* _TUSB_TIMEOUT_TTIMER_H_ */ /** @} */ +/** @} */ + diff --git a/tinyusb/device/dcd.h b/tinyusb/device/dcd.h index 6baac8c69..3aaf443f8 100644 --- a/tinyusb/device/dcd.h +++ b/tinyusb/device/dcd.h @@ -36,11 +36,9 @@ */ /**************************************************************************/ -/** \addtogroup Port Port - * @{ - * \defgroup Port_DCD Device Controller Driver (DCD) - * @{ - */ +/** \ingroup Group_USBD + * \defgroup Group_DCD Device Controller Driver (DCD) + * @{ */ #ifndef _TUSB_DCD_H_ #define _TUSB_DCD_H_ @@ -100,4 +98,3 @@ tusb_error_t dcd_pipe_clear_stall(uint8_t coreid, uint8_t edpt_addr); #endif /* _TUSB_DCD_H_ */ /// @} -/// @} diff --git a/tinyusb/device/dcd_lpc175x_6x.h b/tinyusb/device/dcd_lpc175x_6x.h index 19d166e78..b7e85adc3 100644 --- a/tinyusb/device/dcd_lpc175x_6x.h +++ b/tinyusb/device/dcd_lpc175x_6x.h @@ -36,7 +36,7 @@ */ /**************************************************************************/ -/** \ingroup Port_DCD +/** \ingroup Group_DCD * @{ * \defgroup LPC175x_6x * @{ diff --git a/tinyusb/device/usbd.h b/tinyusb/device/usbd.h index 5532b7fdd..9a7be465c 100644 --- a/tinyusb/device/usbd.h +++ b/tinyusb/device/usbd.h @@ -36,12 +36,9 @@ */ /**************************************************************************/ -/** \ingroup TBD - * \defgroup TBD +/** \defgroup Group_USBD USB Device Driver (USBD) * \brief TBD - * - * @{ - */ + * @{ */ #ifndef _TUSB_USBD_H_ #define _TUSB_USBD_H_ diff --git a/tinyusb/hal/hal.h b/tinyusb/hal/hal.h index c7df7d493..e20907654 100644 --- a/tinyusb/hal/hal.h +++ b/tinyusb/hal/hal.h @@ -39,15 +39,14 @@ #ifndef _TUSB_HAL_H_ #define _TUSB_HAL_H_ -/** \addtogroup Port Port - * @{ +/** \ingroup Group_USBD + * \ingroup Group_USBH * \defgroup Port_Hal Hardware Abtract Layer (HAL) * Hardware Abstraction Layer (HAL) is an abstraction layer, between the physical hardware and the tinyusb stack. * Its function is to hide differences in hardware from most of MCUs, so that most of the stack code does not need to be changed to * run on systems with a different MCU. * HAL are sets of routines that emulate some platform-specific details, giving programs direct access to the hardware resources. - * @{ - */ + * @{ */ //--------------------------------------------------------------------+ // INCLUDES @@ -134,4 +133,3 @@ static inline void hal_debugger_breakpoint(void) #endif /* _TUSB_HAL_H_ */ /** @} */ -/** @} */ diff --git a/tinyusb/host/ehci/ehci.h b/tinyusb/host/ehci/ehci.h index 1d7db7c95..b6500d31f 100644 --- a/tinyusb/host/ehci/ehci.h +++ b/tinyusb/host/ehci/ehci.h @@ -36,7 +36,7 @@ */ /**************************************************************************/ -/** \ingroup Port_HCD +/** \ingroup Group_HCD * @{ * \defgroup EHCI * \brief EHCI driver. All documents sources mentioned here (eg section 3.5) is referring to EHCI Specs unless state otherwise diff --git a/tinyusb/host/hcd.h b/tinyusb/host/hcd.h index c148ccb88..eacda4257 100644 --- a/tinyusb/host/hcd.h +++ b/tinyusb/host/hcd.h @@ -36,11 +36,9 @@ */ /**************************************************************************/ -/** \addtogroup Port Port - * @{ - * \defgroup Port_HCD Host Controller Driver (HCD) - * @{ - */ +/** \ingroup Group_USBH + * \defgroup Group_HCD Host Controller Driver (HCD) + * @{ */ #ifndef _TUSB_HCD_H_ #define _TUSB_HCD_H_ @@ -116,7 +114,6 @@ void hcd_port_unplug(uint8_t hostid); // called by usbh to instruct hcd that it } #endif - #endif /* _TUSB_HCD_H_ */ +#endif /* _TUSB_HCD_H_ */ /// @} -/// @} diff --git a/tinyusb/host/hub.h b/tinyusb/host/hub.h index 956dee505..6097e15e3 100644 --- a/tinyusb/host/hub.h +++ b/tinyusb/host/hub.h @@ -38,7 +38,7 @@ /** \addtogroup ClassDriver * @{ - * \defgroup ClassDriver_Hub Hub (Host) + * \defgroup ClassDriver_Hub Hub (Host only) * \details Like most PC's OS, Hub support is completely hidden from Application. In fact, application cannot determine whether * a device is mounted directly via roothub or via a hub's port. All Hub-related procedures are performed and managed * by tinyusb stack. Unless you are trying to develop the stack itself, there are nothing else can be used by Application. diff --git a/tinyusb/host/ohci/ohci.h b/tinyusb/host/ohci/ohci.h index f03ef94b9..eed6909a2 100644 --- a/tinyusb/host/ohci/ohci.h +++ b/tinyusb/host/ohci/ohci.h @@ -36,12 +36,11 @@ */ /**************************************************************************/ -/** \ingroup Port_HCD +/** \ingroup Group_HCD * @{ * \defgroup OHCI * \brief OHCI driver. All documents sources mentioned here (eg section 3.5) is referring to OHCI Specs unless state otherwise - * @{ - */ + * @{ */ #ifndef _TUSB_OHCI_H_ #define _TUSB_OHCI_H_ diff --git a/tinyusb/host/usbh.h b/tinyusb/host/usbh.h index d828d4bb2..467ab6e95 100644 --- a/tinyusb/host/usbh.h +++ b/tinyusb/host/usbh.h @@ -36,12 +36,9 @@ */ /**************************************************************************/ -/** \ingroup TBD - * \defgroup TBD +/** \defgroup Group_USBH USB Host Driver (USBH) * \brief TBD - * - * @{ - */ + * @{ */ #ifndef _TUSB_USBD_HOST_H_ #define _TUSB_USBD_HOST_H_ diff --git a/tinyusb/host/usbh_hcd.h b/tinyusb/host/usbh_hcd.h index 305b0eb42..bdeb04713 100644 --- a/tinyusb/host/usbh_hcd.h +++ b/tinyusb/host/usbh_hcd.h @@ -36,18 +36,11 @@ */ /**************************************************************************/ -/** \file - * \brief TBD - * - * \note TBD - */ - -/** \ingroup TBD +/** \ingroup Group_HCD + * @{ * \defgroup TBD * \brief TBD - * - * @{ - */ + * @{ */ #ifndef _TUSB_USBH_HCD_H_ #define _TUSB_USBH_HCD_H_ 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" @@ -231,7 +229,6 @@ 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_ */ /** @} */ +/** @} */ -- cgit v1.3.1