mirror/tinyusb
1
0
Fork 0
mirror of https://github.com/hathach/tinyusb.git synced 2025-02-21 21:41:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

doxygen documenting

Browse Source
This commit is contained in:
hathach 2014-03-24 12:35:44 +07:00
parent cf60e374aa
commit a8406060d1
19 changed files with 29 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
tinyusb/common/assertion.h
View File

@ -36,12 +36,10 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup TBD /** \ingroup Group_Common
* \defgroup TBD * \defgroup group_assertion Assertion
* \brief TBD * @{ */
*
* @{
*/
#ifndef _TUSB_ASSERTION_H_ #ifndef _TUSB_ASSERTION_H_
#define _TUSB_ASSERTION_H_ #define _TUSB_ASSERTION_H_

7
tinyusb/common/binary.h
View File

@ -36,12 +36,10 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \addtogroup Group_Common Common Files /** \ingroup Group_Common
* @{ * \defgroup Group_Binary Binary
* \defgroup Group_Binary binary.h
* @{ */ * @{ */
#ifndef _TUSB_BINARY_H_ #ifndef _TUSB_BINARY_H_
#define _TUSB_BINARY_H_ #define _TUSB_BINARY_H_
@ -131,4 +129,3 @@ static inline uint32_t bit_set_range(uint32_t value, uint8_t start, uint8_t end,
#endif /* _TUSB_BINARY_H_ */ #endif /* _TUSB_BINARY_H_ */
/** @} */ /** @} */
/** @} */

2
tinyusb/common/common.h
View File

@ -36,7 +36,7 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \addtogroup Group_Common Common Files /** \defgroup Group_Common Common Files
* @{ * @{
* \defgroup Group_CommonH common.h * \defgroup Group_CommonH common.h
* @{ */ * @{ */

5
tinyusb/common/fifo.h
View File

@ -37,9 +37,8 @@
/**************************************************************************/ /**************************************************************************/
/** \ingroup Group_Common /** \ingroup Group_Common
* * \defgroup group_fifo fifo
* @{ * @{ */
*/
#ifndef _TUSB_FIFO_H_ #ifndef _TUSB_FIFO_H_
#define _TUSB_FIFO_H_ #define _TUSB_FIFO_H_

5
tinyusb/common/timeout_timer.h
View File

@ -36,8 +36,7 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \addtogroup Group_Common Common Files /** \ingroup Group_Common Common Files
* @{
* \defgroup Group_TimeoutTimer timeout timer * \defgroup Group_TimeoutTimer timeout timer
* @{ */ * @{ */
@ -76,5 +75,3 @@ static inline bool timeout_expired(timeout_timer_t* tt)
#endif /* _TUSB_TIMEOUT_TTIMER_H_ */ #endif /* _TUSB_TIMEOUT_TTIMER_H_ */
/** @} */ /** @} */
/** @} */

8
tinyusb/common/tusb_errors.h
View File

@ -36,12 +36,6 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \file
* \brief Error Header
*
* \note TBD
*/
/** \ingroup Group_Common /** \ingroup Group_Common
* \defgroup Group_Error Error Codes * \defgroup Group_Error Error Codes
* @{ * @{
@ -119,4 +113,4 @@ extern char const* const TUSB_ErrorStr[TUSB_ERROR_COUNT];
#endif /* _TUSB_ERRORS_H_ */ #endif /* _TUSB_ERRORS_H_ */
/** @} */ /** @} */

8
tinyusb/device/usbd_dcd.h
View File

@ -36,12 +36,8 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup TBD /** \ingroup Group_USBD
* \defgroup TBD * @{ */
* \brief TBD
*
* @{
*/
#ifndef _TUSB_USBD_DCD_H_ #ifndef _TUSB_USBD_DCD_H_
#define _TUSB_USBD_DCD_H_ #define _TUSB_USBD_DCD_H_

2
tinyusb/hal/hal.h
View File

@ -40,7 +40,7 @@
#define _TUSB_HAL_H_ #define _TUSB_HAL_H_
/** \ingroup Group_USBD /** \ingroup Group_USBD
* \ingroup Group_USBH * \ingroup group_usbh
* \defgroup Port_Hal Hardware Abtract Layer (HAL) * \defgroup Port_Hal Hardware Abtract Layer (HAL)
* Hardware Abstraction Layer (HAL) is an abstraction layer, between the physical hardware and the tinyusb stack. * 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 * 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

2
tinyusb/host/ehci/ehci.h
View File

@ -95,7 +95,7 @@ enum ehci_queue_element_type_{
EHCI_QUEUE_ELEMENT_FSTN ///< 3 EHCI_QUEUE_ELEMENT_FSTN ///< 3
}; };
/// TBD /// EHCI PID
enum tusb_pid_{ enum tusb_pid_{
EHCI_PID_OUT = 0 , EHCI_PID_OUT = 0 ,
EHCI_PID_IN , EHCI_PID_IN ,

2
tinyusb/host/hcd.h
View File

@ -36,7 +36,7 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup Group_USBH /** \ingroup group_usbh
* \defgroup Group_HCD Host Controller Driver (HCD) * \defgroup Group_HCD Host Controller Driver (HCD)
* @{ */ * @{ */

9
tinyusb/host/usbh.h
View File

@ -36,12 +36,11 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \defgroup Group_USBH USB Host Driver (USBH) /** \defgroup group_usbh USB Host Driver (USBH)
* \brief TBD
* @{ */ * @{ */
#ifndef _TUSB_USBD_HOST_H_ #ifndef _TUSB_USBH_H_
#define _TUSB_USBD_HOST_H_ #define _TUSB_USBH_H_
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
@ -112,6 +111,6 @@ tusb_error_t usbh_control_xfer_subtask(uint8_t dev_addr, uint8_t bmRequestType,
} }
#endif #endif
#endif /* _TUSB_USBD_HOST_H_ */ #endif /* _TUSB_USBH_H_ */
/** @} */ /** @} */

3
tinyusb/host/usbh_hcd.h
View File

@ -37,9 +37,6 @@
/**************************************************************************/ /**************************************************************************/
/** \ingroup Group_HCD /** \ingroup Group_HCD
* @{
* \defgroup TBD
* \brief TBD
* @{ */ * @{ */
#ifndef _TUSB_USBH_HCD_H_ #ifndef _TUSB_USBH_HCD_H_

8
tinyusb/host/usbh_hub.h
View File

@ -36,12 +36,8 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup TBD /** \ingroup group_usbh
* \defgroup TBD * @{ */
* \brief TBD
*
* @{
*/
#ifndef _TUSB_USBH_HUB_H_ #ifndef _TUSB_USBH_HUB_H_
#define _TUSB_USBH_HUB_H_ #define _TUSB_USBH_HUB_H_

11
tinyusb/mcu_capacity.h
View File

@ -36,18 +36,9 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \file
* \brief TBD
*
* \note TBD
*/
/** \ingroup TBD /** \ingroup TBD
* \defgroup TBD * \defgroup TBD
* \brief TBD * @{ */
*
* @{
*/
#ifndef _TUSB_MCU_CAPACITY_H_ #ifndef _TUSB_MCU_CAPACITY_H_
#define _TUSB_MCU_CAPACITY_H_ #define _TUSB_MCU_CAPACITY_H_

2
tinyusb/osal/osal.h
View File

@ -50,7 +50,7 @@
/** @} */ /** @} */
/** \defgroup Group_OSAL OS Abstraction Layer (OSAL) /** \defgroup group_osal OS Abstraction Layer (OSAL)
* @{ */ * @{ */
#ifdef __cplusplus #ifdef __cplusplus

2
tinyusb/osal/osal_cmsis_rtx.h
View File

@ -36,7 +36,7 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup Group_OSAL /** \ingroup group_osal
* @{ * @{
* \defgroup Group_CMSISRTX CMSIS-RTOS RTX * \defgroup Group_CMSISRTX CMSIS-RTOS RTX
* @{ */ * @{ */

8
tinyusb/osal/osal_common.h
View File

@ -36,12 +36,8 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup TBD /** \ingroup group_osal
* \defgroup TBD * @{ */
* \brief TBD
*
* @{
*/
#ifndef _TUSB_OSAL_COMMON_H_ #ifndef _TUSB_OSAL_COMMON_H_
#define _TUSB_OSAL_COMMON_H_ #define _TUSB_OSAL_COMMON_H_

2
tinyusb/osal/osal_freeRTOS.h
View File

@ -36,7 +36,7 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup Group_OSAL /** \ingroup group_osal
* @{ * @{
* \defgroup Group_FreeRTOS FreeRTOS * \defgroup Group_FreeRTOS FreeRTOS
* @{ */ * @{ */

4
tinyusb/osal/osal_none.h
View File

@ -36,8 +36,7 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \addtogroup Group_OSAL /** \ingroup group_osal
* @{
* \defgroup Group_OSNone None OS * \defgroup Group_OSNone None OS
* @{ */ * @{ */
@ -320,4 +319,3 @@ static inline void osal_queue_flush(osal_queue_handle_t const queue_hdl)
#endif /* _TUSB_OSAL_NONE_H_ */ #endif /* _TUSB_OSAL_NONE_H_ */
/** @} */ /** @} */
/** @} */