more doxygen works

15 files changed, 32 insertions, 77 deletions

diff --git a/tinyusb/class/cdc.h b/tinyusb/class/cdc.h
index 76ac8a17e..aaab2ace9 100644
--- a/tinyusb/class/cdc.h
+++ b/tinyusb/class/cdc.h
@@ -39,8 +39,7 @@
 /** \ingroup ClassDriver Class Driver

  *  \defgroup ClassDriver_CDC Communication Device Class (CDC)

  *            Currently only Abstract Control Model subclass is supported

- *  @{

- */

+ *  @{ */

 

 #ifndef _TUSB_CDC_H__

 #define _TUSB_CDC_H__

diff --git a/tinyusb/class/cdc_host.h b/tinyusb/class/cdc_host.h
index 183cfd4b8..e4aa47c6f 100644
--- a/tinyusb/class/cdc_host.h
+++ b/tinyusb/class/cdc_host.h
@@ -135,8 +135,7 @@ void tusbh_cdc_xfer_isr(uint8_t dev_addr, tusb_event_t event, cdc_pipeid_t pipe_
 //--------------------------------------------------------------------+

 // RNDIS APPLICATION API

 //--------------------------------------------------------------------+

-/** \ingroup CDC_RNDIS Remote Network Driver Interface Specification (RNDIS)

- * \defgroup CDC_RNSID_Host Host

+/** \ingroup CDC_RNSID_Host

  *  @{ */

 

 bool tusbh_cdc_rndis_is_mounted(uint8_t dev_addr) ATTR_PURE ATTR_WARN_UNUSED_RESULT;

diff --git a/tinyusb/class/cdc_rndis_host.h b/tinyusb/class/cdc_rndis_host.h
index ab0186949..8b68298dd 100644
--- a/tinyusb/class/cdc_rndis_host.h
+++ b/tinyusb/class/cdc_rndis_host.h
@@ -36,12 +36,9 @@
 */
 /**************************************************************************/
 
-/** \ingroup TBD
- *  \defgroup TBD
- *  \brief TBD
- *
- *  @{
- */
+/** \ingroup CDC_RNDIS
+ * \defgroup CDC_RNSID_Host Host
+ *  @{ */
 
 #ifndef _TUSB_CDC_RNDIS_HOST_H_
 #define _TUSB_CDC_RNDIS_HOST_H_
diff --git a/tinyusb/common/primitive_types.h b/tinyusb/common/primitive_types.h
index 470245b30..f85e0299b 100644
--- a/tinyusb/common/primitive_types.h
+++ b/tinyusb/common/primitive_types.h
@@ -36,13 +36,6 @@
 */

 /**************************************************************************/

 

-/** \ingroup TBD

- *  \defgroup TBD

- *  \brief TBD

- *

- *  @{

- */

-

 #ifndef _TUSB_PRIMITIVE_TYPES_H_

 #define _TUSB_PRIMITIVE_TYPES_H_

 

@@ -58,5 +51,3 @@
 #endif

 

 #endif /* _TUSB_PRIMITIVE_TYPES_H_ */

-

-/** @} */

diff --git a/tinyusb/device/dcd.h b/tinyusb/device/dcd.h
index 3aaf443f8..144f5a1aa 100644
--- a/tinyusb/device/dcd.h
+++ b/tinyusb/device/dcd.h
@@ -36,8 +36,8 @@
 */

 /**************************************************************************/

 

-/** \ingroup Group_USBD

- * \defgroup Group_DCD Device Controller Driver (DCD)

+/** \ingroup group_usbd

+ * \defgroup group_dcd Device Controller Driver (DCD)

  *  @{ */

 

 #ifndef _TUSB_DCD_H_

diff --git a/tinyusb/device/dcd_lpc175x_6x.h b/tinyusb/device/dcd_lpc175x_6x.h
index b7e85adc3..cfdcb27b1 100644
--- a/tinyusb/device/dcd_lpc175x_6x.h
+++ b/tinyusb/device/dcd_lpc175x_6x.h
@@ -36,12 +36,9 @@
 */
 /**************************************************************************/
 
-/** \ingroup Group_DCD
- * @{
- *  \defgroup LPC175x_6x
- *  @{
- */
-
+/** \ingroup group_dcd
+ *  \defgroup group_dcd_lpc175x_6x LPC175x_6x
+ *  @{ */
 
 #ifndef _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_ */
 
 /** @} */
-/** @} */
-
diff --git a/tinyusb/device/dcd_lpc43xx.h b/tinyusb/device/dcd_lpc43xx.h
index ba8fcc68d..92bb42769 100644
--- a/tinyusb/device/dcd_lpc43xx.h
+++ b/tinyusb/device/dcd_lpc43xx.h
@@ -36,12 +36,9 @@
 */

 /**************************************************************************/

 

-/** \ingroup TBD

- *  \defgroup TBD

- *  \brief TBD

- *

- *  @{

- */

+/** \ingroup group_dcd

+ *  \defgroup group_dcd_lpc143xx LPC43xx

+ *  @{ */

 

 #ifndef _TUSB_DCD_LPC43XX_H_

 #define _TUSB_DCD_LPC43XX_H_

diff --git a/tinyusb/device/dcd_lpc_11uxx_13uxx.h b/tinyusb/device/dcd_lpc_11uxx_13uxx.h
index 733474693..530fcd808 100644
--- a/tinyusb/device/dcd_lpc_11uxx_13uxx.h
+++ b/tinyusb/device/dcd_lpc_11uxx_13uxx.h
@@ -36,12 +36,9 @@
 */

 /**************************************************************************/

 

-/** \ingroup TBD

- *  \defgroup TBD

- *  \brief TBD

- *

- *  @{

- */

+/** \ingroup group_dcd

+ *  \defgroup group_dcd_lpc11_13u LPC11uxx LPC13uxx

+ *  @{ */

 

 #ifndef _TUSB_DCD_LPC13XX_12ADC_H_

 #define _TUSB_DCD_LPC13XX_12ADC_H_

diff --git a/tinyusb/device/usbd.h b/tinyusb/device/usbd.h
index 01e7c0c04..4b59dc268 100644
--- a/tinyusb/device/usbd.h
+++ b/tinyusb/device/usbd.h
@@ -36,8 +36,7 @@
 */

 /**************************************************************************/

 

-/** \defgroup Group_USBD USB Device Driver (USBD)

- *  \brief TBD

+/** \defgroup group_usbd USB Device Driver (USBD)

  *  @{ */

 

 #ifndef _TUSB_USBD_H_

diff --git a/tinyusb/device/usbd_dcd.h b/tinyusb/device/usbd_dcd.h
index 1096c5e26..cf422ac6a 100644
--- a/tinyusb/device/usbd_dcd.h
+++ b/tinyusb/device/usbd_dcd.h
@@ -36,7 +36,7 @@
 */

 /**************************************************************************/

 

-/** \ingroup Group_USBD

+/** \ingroup group_usbd

  *  @{ */

 

 #ifndef _TUSB_USBD_DCD_H_

diff --git a/tinyusb/hal/hal.h b/tinyusb/hal/hal.h
index 9648a09b6..8029685f0 100644
--- a/tinyusb/hal/hal.h
+++ b/tinyusb/hal/hal.h
@@ -39,9 +39,9 @@
 #ifndef _TUSB_HAL_H_

 #define _TUSB_HAL_H_

 

-/** \ingroup Group_USBD

+/** \ingroup group_usbd

  * \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.

  * 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.

diff --git a/tinyusb/hal/hal_lpc11uxx.h b/tinyusb/hal/hal_lpc11uxx.h
index 649a7ce86..b497d3778 100644
--- a/tinyusb/hal/hal_lpc11uxx.h
+++ b/tinyusb/hal/hal_lpc11uxx.h
@@ -36,12 +36,9 @@
 */

 /**************************************************************************/

 

-/** \ingroup TBD

- *  \defgroup TBD

- *  \brief TBD

- *

- *  @{

- */

+/** \ingroup group_hal

+ *  \defgroup group_hal_lpc11u LPC11uxx

+ *  @{ */

 

 #ifndef _TUSB_HAL_LPC11UXX_H_

 #define _TUSB_HAL_LPC11UXX_H_

diff --git a/tinyusb/hal/hal_lpc13uxx.h b/tinyusb/hal/hal_lpc13uxx.h
index 1ccad5df1..552fe6b56 100644
--- a/tinyusb/hal/hal_lpc13uxx.h
+++ b/tinyusb/hal/hal_lpc13uxx.h
@@ -36,12 +36,9 @@
 */

 /**************************************************************************/

 

-/** \ingroup TBD

- *  \defgroup TBD

- *  \brief TBD

- *

- *  @{

- */

+/** \ingroup group_hal

+ *  \defgroup group_hal_lpc13u LPC13uxx (12-bit ADC)

+ *  @{ */

 

 #ifndef _TUSB_HAL_LPC13UXX_H_

 #define _TUSB_HAL_LPC13UXX_H_

diff --git a/tinyusb/hal/hal_lpc175x_6x.h b/tinyusb/hal/hal_lpc175x_6x.h
index e0ab4f59a..47658c6aa 100644
--- a/tinyusb/hal/hal_lpc175x_6x.h
+++ b/tinyusb/hal/hal_lpc175x_6x.h
@@ -36,12 +36,9 @@
 */
 /**************************************************************************/
 
-/** \ingroup TBD
- *  \defgroup TBD
- *  \brief TBD
- *
- *  @{
- */
+/** \ingroup group_hal
+ *  \defgroup group_hal_lpc175x_6x LPC175x_6x
+ *  @{ */
 
 #ifndef _TUSB_HAL_LPC175X_6X_H_
 #define _TUSB_HAL_LPC175X_6X_H_
diff --git a/tinyusb/hal/hal_lpc43xx.h b/tinyusb/hal/hal_lpc43xx.h
index f5b5c4d96..4aafc1e3e 100644
--- a/tinyusb/hal/hal_lpc43xx.h
+++ b/tinyusb/hal/hal_lpc43xx.h
@@ -36,19 +36,9 @@
 */

 /**************************************************************************/

 

-/** \file

- *  \brief TBD

- *

- *  \note TBD

- */

-

-/** \ingroup TBD

- *  \defgroup TBD

- *  \brief TBD

- *

- *  @{

- */

-

+/** \ingroup group_hal

+ *  \defgroup group_hal_lpc143xx LPC43xx

+ *  @{ */

 #ifndef _TUSB_HAL_LPC43XX_H_

 #define _TUSB_HAL_LPC43XX_H_