more doxygen work

5 files changed, 39 insertions, 64 deletions

diff --git a/tinyusb/device/dcd.h b/tinyusb/device/dcd.h
index 73aa1620e..4d6c7c08a 100644
--- a/tinyusb/device/dcd.h
+++ b/tinyusb/device/dcd.h
@@ -36,28 +36,21 @@
 */
 /**************************************************************************/
 
-/** \file
- *  \brief Device Controller Driver
- *
- *  \note TBD
- */
-
-/** 
- *  \defgroup Group_DCD Device Controller Driver
- *  \brief Device Controller Driver
- *
+/** \addtogroup Port Port
+ *  @{
+ *  \defgroup Port_DCD Device Controller Driver (DCD)
  *  @{
  */
 
 #ifndef _TUSB_DCD_H_
 #define _TUSB_DCD_H_
 
+#include "common/common.h"
+
 #ifdef __cplusplus
  extern "C" {
 #endif
 
-#include "common/common.h"
-
 tusb_error_t dcd_init(void) ATTR_WARN_UNUSED_RESULT;
 tusb_error_t dcd_controller_reset(uint8_t coreid) ATTR_WARN_UNUSED_RESULT;
 void dcd_controller_connect(uint8_t coreid);
@@ -78,3 +71,4 @@ void dcd_device_set_configuration(uint8_t coreid, uint8_t config_num);
 #endif /* _TUSB_DCD_H_ */
 
 /// @}
+/// @}
diff --git a/tinyusb/hal/hal.h b/tinyusb/hal/hal.h
index b0de23422..9e336de0f 100644
--- a/tinyusb/hal/hal.h
+++ b/tinyusb/hal/hal.h
@@ -36,22 +36,16 @@
 */
 /**************************************************************************/
 
-/** \file
- *  \brief TBD
- *
- *  \note TBD
- */
+#ifndef _TUSB_HAL_H_
+#define _TUSB_HAL_H_
 
-/**
- *  \defgroup Group_HAL Hardware Abtract Layer
- *  \brief Hardware dependent layer
- *
+/** \addtogroup Port Port
+ * @{
+ *  \defgroup Port_Hal Hardware Abtract Layer (HAL)
+ *  \brief Hardware Dependent Layer
  *  @{
  */
 
-#ifndef _TUSB_HAL_H_
-#define _TUSB_HAL_H_
-
 //--------------------------------------------------------------------+
 // INCLUDES
 //--------------------------------------------------------------------+
@@ -124,3 +118,4 @@ 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 ea1d6bdf6..dbb05ee9b 100644
--- a/tinyusb/host/ehci/ehci.h
+++ b/tinyusb/host/ehci/ehci.h
@@ -36,13 +36,8 @@
 */
 /**************************************************************************/
 
-/** \file
- *  \brief EHCI
- *
- *  \note TBD
- */
-
-/** \ingroup Group_HCD
+/** \ingroup Port_HCD
+ * @{
  *  \defgroup EHCI
  *  \brief EHCI driver. All documents sources mentioned here (eg section 3.5) is referring to EHCI Specs unless state otherwise
  *
@@ -483,4 +478,5 @@ tusb_error_t hcd_controller_reset(uint8_t hostid) ATTR_WARN_UNUSED_RESULT;
 #endif /* _TUSB_EHCI_H_ */
 
 /** @} */
+/** @} */
 
diff --git a/tinyusb/host/hcd.h b/tinyusb/host/hcd.h
index 816afd3a3..34e89fea4 100644
--- a/tinyusb/host/hcd.h
+++ b/tinyusb/host/hcd.h
@@ -36,28 +36,21 @@
 */
 /**************************************************************************/
 
-/** \file
- *  \brief Host Controller Driver
- *
- *  \note TBD
- */
-
-/** 
- *  \defgroup Group_HCD Host Controller Driver
- *  \brief Host Controller Driver
- *
+/** \addtogroup Port Port
+ *  @{
+ *  \defgroup Port_HCD Host Controller Driver (HCD)
  *  @{
  */
 
 #ifndef _TUSB_HCD_H_
 #define _TUSB_HCD_H_
 
+#include "common/common.h"
+
 #ifdef __cplusplus
  extern "C" {
 #endif
 
-#include "common/common.h"
-
 //--------------------------------------------------------------------+
 // MACRO CONSTANT TYPEDEF
 //--------------------------------------------------------------------+
@@ -126,3 +119,4 @@ void hcd_port_unplug(uint8_t hostid); // called by usbh to instruct hcd that it
  #endif /* _TUSB_HCD_H_ */
 
 /// @}
+/// @}
diff --git a/tinyusb/osal/osal.h b/tinyusb/osal/osal.h
index 4c45b0087..84a18a685 100644
--- a/tinyusb/osal/osal.h
+++ b/tinyusb/osal/osal.h
@@ -36,28 +36,9 @@
 */

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

 

-/** \file

- *  \brief TBD

- *

- *  \note TBD

- */

-

-/** \ingroup TBD

- *  \defgroup TBD

- *  \brief TBD

- *

- *  @{

- */

-

 #ifndef _TUSB_OSAL_H_

 #define _TUSB_OSAL_H_

 

-#ifdef __cplusplus

- extern "C" {

-#endif

-

-#include "tusb_option.h"

-

 /** \ingroup group_configuration

  *  \defgroup TUSB_OS RTOS Integration Selection

  * \brief TUSB_CFG_OS must be defined to one of these

@@ -69,6 +50,20 @@
 #define TUSB_OS_UCOS3      5 ///< MicroC OS III is used (not supported yet)

 /** @} */

 

+

+/** \addtogroup Port Port

+ * @{

+ *  \defgroup Port_OSAL  OS Abstraction Layer (OSAL)

+ *  @{

+ */

+

+

+#ifdef __cplusplus

+ extern "C" {

+#endif

+

+#include "tusb_option.h"

+

 #ifndef _TEST_

 

 #if TUSB_CFG_OS == TUSB_OS_NONE

@@ -204,6 +199,7 @@ uint32_t osal_tick_get(void);
  }

 #endif

 

-#endif /* _TUSB_OSAL_H_ */

-

 /** @} */

+/** @} */

+

+#endif /* _TUSB_OSAL_H_ */