more doxygen works

This commit is contained in:
hathach 2014-03-24 13:06:40 +07:00
parent a8406060d1
commit 68d96edc13
15 changed files with 32 additions and 77 deletions

View File

@ -39,8 +39,7 @@
/** \ingroup ClassDriver Class Driver /** \ingroup ClassDriver Class Driver
* \defgroup ClassDriver_CDC Communication Device Class (CDC) * \defgroup ClassDriver_CDC Communication Device Class (CDC)
* Currently only Abstract Control Model subclass is supported * Currently only Abstract Control Model subclass is supported
* @{ * @{ */
*/
#ifndef _TUSB_CDC_H__ #ifndef _TUSB_CDC_H__
#define _TUSB_CDC_H__ #define _TUSB_CDC_H__

View File

@ -135,8 +135,7 @@ void tusbh_cdc_xfer_isr(uint8_t dev_addr, tusb_event_t event, cdc_pipeid_t pipe_
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
// RNDIS APPLICATION API // RNDIS APPLICATION API
//--------------------------------------------------------------------+ //--------------------------------------------------------------------+
/** \ingroup CDC_RNDIS Remote Network Driver Interface Specification (RNDIS) /** \ingroup CDC_RNSID_Host
* \defgroup CDC_RNSID_Host Host
* @{ */ * @{ */
bool tusbh_cdc_rndis_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT; bool tusbh_cdc_rndis_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;

View File

@ -36,12 +36,9 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup TBD /** \ingroup CDC_RNDIS
* \defgroup TBD * \defgroup CDC_RNSID_Host Host
* \brief TBD * @{ */
*
* @{
*/
#ifndef _TUSB_CDC_RNDIS_HOST_H_ #ifndef _TUSB_CDC_RNDIS_HOST_H_
#define _TUSB_CDC_RNDIS_HOST_H_ #define _TUSB_CDC_RNDIS_HOST_H_

View File

@ -36,13 +36,6 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup TBD
* \defgroup TBD
* \brief TBD
*
* @{
*/
#ifndef _TUSB_PRIMITIVE_TYPES_H_ #ifndef _TUSB_PRIMITIVE_TYPES_H_
#define _TUSB_PRIMITIVE_TYPES_H_ #define _TUSB_PRIMITIVE_TYPES_H_
@ -58,5 +51,3 @@
#endif #endif
#endif /* _TUSB_PRIMITIVE_TYPES_H_ */ #endif /* _TUSB_PRIMITIVE_TYPES_H_ */
/** @} */

View File

@ -36,8 +36,8 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup Group_USBD /** \ingroup group_usbd
* \defgroup Group_DCD Device Controller Driver (DCD) * \defgroup group_dcd Device Controller Driver (DCD)
* @{ */ * @{ */
#ifndef _TUSB_DCD_H_ #ifndef _TUSB_DCD_H_

View File

@ -36,12 +36,9 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup Group_DCD /** \ingroup group_dcd
* @{ * \defgroup group_dcd_lpc175x_6x LPC175x_6x
* \defgroup LPC175x_6x * @{ */
* @{
*/
#ifndef _TUSB_DCD_LPC175X_6X_H_ #ifndef _TUSB_DCD_LPC175X_6X_H_
#define _TUSB_DCD_LPC175X_6X_H_ #define _TUSB_DCD_LPC175X_6X_H_
@ -239,5 +236,3 @@ static inline uint32_t sie_read (uint8_t cmd_code, uint8_t data_len)
#endif /* _TUSB_DCD_LPC175X_6X_H_ */ #endif /* _TUSB_DCD_LPC175X_6X_H_ */
/** @} */ /** @} */
/** @} */

View File

@ -36,12 +36,9 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup TBD /** \ingroup group_dcd
* \defgroup TBD * \defgroup group_dcd_lpc143xx LPC43xx
* \brief TBD * @{ */
*
* @{
*/
#ifndef _TUSB_DCD_LPC43XX_H_ #ifndef _TUSB_DCD_LPC43XX_H_
#define _TUSB_DCD_LPC43XX_H_ #define _TUSB_DCD_LPC43XX_H_

View File

@ -36,12 +36,9 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup TBD /** \ingroup group_dcd
* \defgroup TBD * \defgroup group_dcd_lpc11_13u LPC11uxx LPC13uxx
* \brief TBD * @{ */
*
* @{
*/
#ifndef _TUSB_DCD_LPC13XX_12ADC_H_ #ifndef _TUSB_DCD_LPC13XX_12ADC_H_
#define _TUSB_DCD_LPC13XX_12ADC_H_ #define _TUSB_DCD_LPC13XX_12ADC_H_

View File

@ -36,8 +36,7 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \defgroup Group_USBD USB Device Driver (USBD) /** \defgroup group_usbd USB Device Driver (USBD)
* \brief TBD
* @{ */ * @{ */
#ifndef _TUSB_USBD_H_ #ifndef _TUSB_USBD_H_

View File

@ -36,7 +36,7 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup Group_USBD /** \ingroup group_usbd
* @{ */ * @{ */
#ifndef _TUSB_USBD_DCD_H_ #ifndef _TUSB_USBD_DCD_H_

View File

@ -39,9 +39,9 @@
#ifndef _TUSB_HAL_H_ #ifndef _TUSB_HAL_H_
#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 group_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
* run on systems with a different MCU. * run on systems with a different MCU.

View File

@ -36,12 +36,9 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup TBD /** \ingroup group_hal
* \defgroup TBD * \defgroup group_hal_lpc11u LPC11uxx
* \brief TBD * @{ */
*
* @{
*/
#ifndef _TUSB_HAL_LPC11UXX_H_ #ifndef _TUSB_HAL_LPC11UXX_H_
#define _TUSB_HAL_LPC11UXX_H_ #define _TUSB_HAL_LPC11UXX_H_

View File

@ -36,12 +36,9 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup TBD /** \ingroup group_hal
* \defgroup TBD * \defgroup group_hal_lpc13u LPC13uxx (12-bit ADC)
* \brief TBD * @{ */
*
* @{
*/
#ifndef _TUSB_HAL_LPC13UXX_H_ #ifndef _TUSB_HAL_LPC13UXX_H_
#define _TUSB_HAL_LPC13UXX_H_ #define _TUSB_HAL_LPC13UXX_H_

View File

@ -36,12 +36,9 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \ingroup TBD /** \ingroup group_hal
* \defgroup TBD * \defgroup group_hal_lpc175x_6x LPC175x_6x
* \brief TBD * @{ */
*
* @{
*/
#ifndef _TUSB_HAL_LPC175X_6X_H_ #ifndef _TUSB_HAL_LPC175X_6X_H_
#define _TUSB_HAL_LPC175X_6X_H_ #define _TUSB_HAL_LPC175X_6X_H_

View File

@ -36,19 +36,9 @@
*/ */
/**************************************************************************/ /**************************************************************************/
/** \file /** \ingroup group_hal
* \brief TBD * \defgroup group_hal_lpc143xx LPC43xx
* * @{ */
* \note TBD
*/
/** \ingroup TBD
* \defgroup TBD
* \brief TBD
*
* @{
*/
#ifndef _TUSB_HAL_LPC43XX_H_ #ifndef _TUSB_HAL_LPC43XX_H_
#define _TUSB_HAL_LPC43XX_H_ #define _TUSB_HAL_LPC43XX_H_