doxygen documenting

19 files changed, 29 insertions, 71 deletions

diff --git a/tinyusb/common/assertion.h b/tinyusb/common/assertion.h
index 2a847731a..329bc11db 100644
--- a/tinyusb/common/assertion.h
+++ b/tinyusb/common/assertion.h
@@ -36,12 +36,10 @@
 */

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

 

-/** \ingroup TBD

- *  \defgroup TBD

- *  \brief TBD

- *

- *  @{

- */

+/** \ingroup Group_Common

+ *  \defgroup group_assertion Assertion

+ *  @{ */

+

 

 #ifndef _TUSB_ASSERTION_H_

 #define _TUSB_ASSERTION_H_

diff --git a/tinyusb/common/binary.h b/tinyusb/common/binary.h
index 6beeb8595..6860295de 100644
--- a/tinyusb/common/binary.h
+++ b/tinyusb/common/binary.h
@@ -36,12 +36,10 @@
 */

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

 

-/** \addtogroup Group_Common Common Files

- * @{

- *  \defgroup Group_Binary binary.h

+/** \ingroup Group_Common

+ *  \defgroup Group_Binary Binary

  *  @{ */

 

-

 #ifndef _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_ */

 

 /** @} */

-/** @} */

diff --git a/tinyusb/common/common.h b/tinyusb/common/common.h
index b63593ac6..6a6e00701 100644
--- a/tinyusb/common/common.h
+++ b/tinyusb/common/common.h
@@ -36,7 +36,7 @@
 */

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

 

-/** \addtogroup Group_Common Common Files

+/** \defgroup Group_Common Common Files

  * @{

  *  \defgroup Group_CommonH common.h

  *  @{ */

diff --git a/tinyusb/common/fifo.h b/tinyusb/common/fifo.h
index 98a8fbcd2..113c21a5d 100644
--- a/tinyusb/common/fifo.h
+++ b/tinyusb/common/fifo.h
@@ -37,9 +37,8 @@
 /**************************************************************************/

 

 /** \ingroup Group_Common

- *

- *  @{

- */

+ * \defgroup group_fifo fifo

+ *  @{ */

 

 #ifndef _TUSB_FIFO_H_

 #define _TUSB_FIFO_H_

diff --git a/tinyusb/common/timeout_timer.h b/tinyusb/common/timeout_timer.h
index b1919638d..885b3901c 100644
--- a/tinyusb/common/timeout_timer.h
+++ b/tinyusb/common/timeout_timer.h
@@ -36,8 +36,7 @@
 */

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

 

-/** \addtogroup Group_Common Common Files

- * @{

+/** \ingroup Group_Common Common Files

  *  \defgroup Group_TimeoutTimer timeout timer

  *  @{ */

 

@@ -76,5 +75,3 @@ static inline bool timeout_expired(timeout_timer_t* tt)
 #endif /* _TUSB_TIMEOUT_TTIMER_H_ */

 

 /** @} */

-/** @} */

-

diff --git a/tinyusb/common/tusb_errors.h b/tinyusb/common/tusb_errors.h
index 6d991c38a..81b1f0906 100644
--- a/tinyusb/common/tusb_errors.h
+++ b/tinyusb/common/tusb_errors.h
@@ -36,12 +36,6 @@
 */

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

 

-/** \file

- *  \brief Error Header

- *

- *  \note TBD

- */

-

 /** \ingroup Group_Common

  *  \defgroup Group_Error Error Codes

  *  @{

@@ -119,4 +113,4 @@ extern char const* const TUSB_ErrorStr[TUSB_ERROR_COUNT];
 

 #endif /* _TUSB_ERRORS_H_ */

 

- /**  @} */

+/**  @} */

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

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

 

-/** \ingroup TBD

- *  \defgroup TBD

- *  \brief TBD

- *

- *  @{

- */

+/** \ingroup Group_USBD

+ *  @{ */

 

 #ifndef _TUSB_USBD_DCD_H_

 #define _TUSB_USBD_DCD_H_

diff --git a/tinyusb/hal/hal.h b/tinyusb/hal/hal.h
index 9170f3f5b..9648a09b6 100644
--- a/tinyusb/hal/hal.h
+++ b/tinyusb/hal/hal.h
@@ -40,7 +40,7 @@
 #define _TUSB_HAL_H_

 

 /** \ingroup Group_USBD

- * \ingroup Group_USBH

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

diff --git a/tinyusb/host/ehci/ehci.h b/tinyusb/host/ehci/ehci.h
index b6500d31f..7b3ddfaac 100644
--- a/tinyusb/host/ehci/ehci.h
+++ b/tinyusb/host/ehci/ehci.h
@@ -95,7 +95,7 @@ enum ehci_queue_element_type_{
   EHCI_QUEUE_ELEMENT_FSTN      ///< 3
 };
 
-/// TBD
+/// EHCI PID
 enum tusb_pid_{
   EHCI_PID_OUT = 0 ,
   EHCI_PID_IN      ,
diff --git a/tinyusb/host/hcd.h b/tinyusb/host/hcd.h
index eacda4257..0515f7a92 100644
--- a/tinyusb/host/hcd.h
+++ b/tinyusb/host/hcd.h
@@ -36,7 +36,7 @@
 */

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

 

-/** \ingroup Group_USBH

+/** \ingroup group_usbh

  * \defgroup Group_HCD Host Controller Driver (HCD)

  *  @{ */

 

diff --git a/tinyusb/host/usbh.h b/tinyusb/host/usbh.h
index efddfbeb9..87ceff66b 100644
--- a/tinyusb/host/usbh.h
+++ b/tinyusb/host/usbh.h
@@ -36,12 +36,11 @@
 */
 /**************************************************************************/
 
-/** \defgroup Group_USBH USB Host Driver (USBH)
- *  \brief TBD
+/** \defgroup group_usbh USB Host Driver (USBH)
  *  @{ */
 
-#ifndef _TUSB_USBD_HOST_H_
-#define _TUSB_USBD_HOST_H_
+#ifndef _TUSB_USBH_H_
+#define _TUSB_USBH_H_
 
 #ifdef __cplusplus
  extern "C" {
@@ -112,6 +111,6 @@ tusb_error_t usbh_control_xfer_subtask(uint8_t dev_addr, uint8_t bmRequestType,
  }
 #endif
 
-#endif /* _TUSB_USBD_HOST_H_ */
+#endif /* _TUSB_USBH_H_ */
 
 /** @} */
diff --git a/tinyusb/host/usbh_hcd.h b/tinyusb/host/usbh_hcd.h
index bdeb04713..92b2663f9 100644
--- a/tinyusb/host/usbh_hcd.h
+++ b/tinyusb/host/usbh_hcd.h
@@ -37,9 +37,6 @@
 /**************************************************************************/
 
 /** \ingroup Group_HCD
- * @{
- *  \defgroup TBD
- *  \brief TBD
  *  @{ */
 
 #ifndef _TUSB_USBH_HCD_H_
diff --git a/tinyusb/host/usbh_hub.h b/tinyusb/host/usbh_hub.h
index c1337f928..c6a8716e5 100644
--- a/tinyusb/host/usbh_hub.h
+++ b/tinyusb/host/usbh_hub.h
@@ -36,12 +36,8 @@
 */
 /**************************************************************************/
 
-/** \ingroup TBD
- *  \defgroup TBD
- *  \brief TBD
- *
- *  @{
- */
+/** \ingroup group_usbh
+ *  @{ */
 
 #ifndef _TUSB_USBH_HUB_H_
 #define _TUSB_USBH_HUB_H_
diff --git a/tinyusb/mcu_capacity.h b/tinyusb/mcu_capacity.h
index 3b9181700..3e7280111 100644
--- a/tinyusb/mcu_capacity.h
+++ b/tinyusb/mcu_capacity.h
@@ -36,18 +36,9 @@
 */

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

 

-/** \file

- *  \brief TBD

- *

- *  \note TBD

- */

-

 /** \ingroup TBD

  *  \defgroup TBD

- *  \brief TBD

- *

- *  @{

- */

+ *  @{ */

 

 #ifndef _TUSB_MCU_CAPACITY_H_

 #define _TUSB_MCU_CAPACITY_H_

diff --git a/tinyusb/osal/osal.h b/tinyusb/osal/osal.h
index dd39da281..ca4015a2d 100644
--- a/tinyusb/osal/osal.h
+++ b/tinyusb/osal/osal.h
@@ -50,7 +50,7 @@
 /** @} */

 

 

-/** \defgroup Group_OSAL OS Abstraction Layer (OSAL)

+/** \defgroup group_osal OS Abstraction Layer (OSAL)

  *  @{ */

 

 #ifdef __cplusplus

diff --git a/tinyusb/osal/osal_cmsis_rtx.h b/tinyusb/osal/osal_cmsis_rtx.h
index 0495df069..57f015d82 100644
--- a/tinyusb/osal/osal_cmsis_rtx.h
+++ b/tinyusb/osal/osal_cmsis_rtx.h
@@ -36,7 +36,7 @@
 */
 /**************************************************************************/
 
-/** \ingroup Group_OSAL
+/** \ingroup group_osal
  *  @{
  *  \defgroup Group_CMSISRTX CMSIS-RTOS RTX
  *  @{ */
diff --git a/tinyusb/osal/osal_common.h b/tinyusb/osal/osal_common.h
index 9add3e877..0a2608933 100644
--- a/tinyusb/osal/osal_common.h
+++ b/tinyusb/osal/osal_common.h
@@ -36,12 +36,8 @@
 */

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

 

-/** \ingroup TBD

- *  \defgroup TBD

- *  \brief TBD

- *

- *  @{

- */

+/** \ingroup group_osal

+ *  @{ */

 

 #ifndef _TUSB_OSAL_COMMON_H_

 #define _TUSB_OSAL_COMMON_H_

diff --git a/tinyusb/osal/osal_freeRTOS.h b/tinyusb/osal/osal_freeRTOS.h
index 3a99589d0..536a7a097 100644
--- a/tinyusb/osal/osal_freeRTOS.h
+++ b/tinyusb/osal/osal_freeRTOS.h
@@ -36,7 +36,7 @@
 */
 /**************************************************************************/
 
-/** \ingroup Group_OSAL
+/** \ingroup group_osal
  * @{
  *  \defgroup Group_FreeRTOS  FreeRTOS
  *  @{ */
diff --git a/tinyusb/osal/osal_none.h b/tinyusb/osal/osal_none.h
index 435493586..040f73706 100644
--- a/tinyusb/osal/osal_none.h
+++ b/tinyusb/osal/osal_none.h
@@ -36,8 +36,7 @@
 */

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

 

-/** \addtogroup Group_OSAL

- * @{

+/** \ingroup group_osal

  * \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_ */

 

 /** @} */

-/** @} */