doxygen documenting

5 files changed, 14 insertions, 35 deletions

diff --git a/tinyusb/hal/hal.h b/tinyusb/hal/hal.h
index 8029685f0..650c16eca 100644
--- a/tinyusb/hal/hal.h
+++ b/tinyusb/hal/hal.h
@@ -39,15 +39,6 @@
 #ifndef _TUSB_HAL_H_

 #define _TUSB_HAL_H_

 

-/** \ingroup group_usbd

- * \ingroup group_usbh

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

- * HAL are sets of routines that emulate some platform-specific details, giving programs direct access to the hardware resources.

- *  @{ */

-

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

 // INCLUDES

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

@@ -56,11 +47,19 @@
 #include "common/tusb_errors.h"

 #include "common/compiler/compiler.h"

 

+// callback from tusb.h

+extern void tusb_isr(uint8_t coreid);

+

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

 // HAL API

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

-// callback from tusb.h

-extern void tusb_isr(uint8_t coreid);

+/** \ingroup group_mcu

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

+ * HAL are sets of routines that emulate some platform-specific details, giving programs direct access to the hardware resources.

+ *  @{ */

 

 /** \brief    Initialize USB controller hardware

  * \returns   \ref tusb_error_t type to indicate success or error condition.

diff --git a/tinyusb/hal/hal_lpc11uxx.h b/tinyusb/hal/hal_lpc11uxx.h
index b497d3778..d94aa3dd3 100644
--- a/tinyusb/hal/hal_lpc11uxx.h
+++ b/tinyusb/hal/hal_lpc11uxx.h
@@ -36,10 +36,6 @@
 */

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

 

-/** \ingroup group_hal

- *  \defgroup group_hal_lpc11u LPC11uxx

- *  @{ */

-

 #ifndef _TUSB_HAL_LPC11UXX_H_

 #define _TUSB_HAL_LPC11UXX_H_

 

@@ -66,5 +62,3 @@ static inline void hal_interrupt_disable(uint8_t coreid)
 #endif

 

 #endif /* _TUSB_HAL_LPC11UXX_H_ */

-

-/** @} */

diff --git a/tinyusb/hal/hal_lpc13uxx.h b/tinyusb/hal/hal_lpc13uxx.h
index 552fe6b56..c5dc8afd4 100644
--- a/tinyusb/hal/hal_lpc13uxx.h
+++ b/tinyusb/hal/hal_lpc13uxx.h
@@ -36,10 +36,6 @@
 */

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

 

-/** \ingroup group_hal

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

- *  @{ */

-

 #ifndef _TUSB_HAL_LPC13UXX_H_

 #define _TUSB_HAL_LPC13UXX_H_

 

@@ -67,4 +63,3 @@ static inline void hal_interrupt_disable(uint8_t coreid)
 

 #endif /* _TUSB_HAL_LPC13UXX_H_ */

 

-/** @} */

diff --git a/tinyusb/hal/hal_lpc175x_6x.h b/tinyusb/hal/hal_lpc175x_6x.h
index 47658c6aa..744454110 100644
--- a/tinyusb/hal/hal_lpc175x_6x.h
+++ b/tinyusb/hal/hal_lpc175x_6x.h
@@ -36,10 +36,6 @@
 */
 /**************************************************************************/
 
-/** \ingroup group_hal
- *  \defgroup group_hal_lpc175x_6x LPC175x_6x
- *  @{ */
-
 #ifndef _TUSB_HAL_LPC175X_6X_H_
 #define _TUSB_HAL_LPC175X_6X_H_
 
@@ -53,15 +49,15 @@
 //--------------------------------------------------------------------+
 //
 //--------------------------------------------------------------------+
-static inline void hal_interrupt_enable(uint8_t controller_id)
+static inline void hal_interrupt_enable(uint8_t coreid)
 {
-  (void) controller_id; // discard compiler's warning
+  (void) coreid; // discard compiler's warning
   NVIC_EnableIRQ(USB_IRQn);
 }
 
-static inline void hal_interrupt_disable(uint8_t controller_id)
+static inline void hal_interrupt_disable(uint8_t coreid)
 {
-  (void) controller_id; // discard compiler's warning
+  (void) coreid; // discard compiler's warning
   NVIC_DisableIRQ(USB_IRQn);
 }
 
@@ -71,4 +67,3 @@ static inline void hal_interrupt_disable(uint8_t controller_id)
 
 #endif /* _TUSB_HAL_LPC175X_6X_H_ */
 
-/** @} */
diff --git a/tinyusb/hal/hal_lpc43xx.h b/tinyusb/hal/hal_lpc43xx.h
index 4aafc1e3e..6360384ea 100644
--- a/tinyusb/hal/hal_lpc43xx.h
+++ b/tinyusb/hal/hal_lpc43xx.h
@@ -36,9 +36,6 @@
 */

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

 

-/** \ingroup group_hal

- *  \defgroup group_hal_lpc143xx LPC43xx

- *  @{ */

 #ifndef _TUSB_HAL_LPC43XX_H_

 #define _TUSB_HAL_LPC43XX_H_

 

@@ -64,4 +61,3 @@ static inline void hal_interrupt_disable(uint8_t coreid)
 

 #endif /* _TUSB_HAL_LPC43XX_H_ */

 

-/** @} */