diff options
| author | hathach <[email protected]> | 2014-03-25 13:11:22 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2014-03-25 13:11:22 +0700 |
| commit | 45aef4c04c0ec7627780a135594d361c94256956 (patch) | |
| tree | 3889d22a69e8bed8d9965aafdf7eaccb787963dd /tinyusb | |
| parent | 15d0139bc5d17bb8cda5bf98c3ae5631b62f1e84 (diff) | |
more doxygen stuffs
Diffstat (limited to 'tinyusb')
| -rw-r--r-- | tinyusb/common/common.h | 4 | ||||
| -rw-r--r-- | tinyusb/common/std_descriptors.h | 4 | ||||
| -rw-r--r-- | tinyusb/device/usbd.h | 2 | ||||
| -rw-r--r-- | tinyusb/doxygen/group_def.txt | 13 | ||||
| -rw-r--r-- | tinyusb/host/usbh.h | 2 | ||||
| -rw-r--r-- | tinyusb/osal/osal.h | 2 |
6 files changed, 18 insertions, 9 deletions
diff --git a/tinyusb/common/common.h b/tinyusb/common/common.h index 6a6e00701..e1ff26e89 100644 --- a/tinyusb/common/common.h +++ b/tinyusb/common/common.h @@ -36,8 +36,7 @@ */
/**************************************************************************/
-/** \defgroup Group_Common Common Files
- * @{
+/** \ingroup Group_Common
* \defgroup Group_CommonH common.h
* @{ */
@@ -285,4 +284,3 @@ static inline uint8_t cardinality_of(uint32_t value) #endif /* _TUSB_COMMON_H_ */
/** @} */
-/** @} */
diff --git a/tinyusb/common/std_descriptors.h b/tinyusb/common/std_descriptors.h index bf34008e2..2deb43c7d 100644 --- a/tinyusb/common/std_descriptors.h +++ b/tinyusb/common/std_descriptors.h @@ -38,8 +38,7 @@ /// \brief Types & Declaration by USB Specs. All documents sources mentioned here (eg section 3.5) is referring to USB 2.0 Specs unless state otherwise
-/** \addtogroup group_usb_definitions USB Definitions
- * @{
+/** \ingroup group_usb_definitions
* \defgroup Group_StdDescriptor Standard Descriptors
* @{ */
@@ -188,4 +187,3 @@ typedef ATTR_PACKED_STRUCT(struct) #endif /* _TUSB_STD_DESCRIPTORS_H_ */
/** @} */
-/** @} */
diff --git a/tinyusb/device/usbd.h b/tinyusb/device/usbd.h index 6ecc0a47a..2144819e0 100644 --- a/tinyusb/device/usbd.h +++ b/tinyusb/device/usbd.h @@ -36,7 +36,7 @@ */
/**************************************************************************/
-/** \defgroup group_usbd USB Device Core (USBD)
+/** \ingroup group_usbd
* @{ */
#ifndef _TUSB_USBD_H_
diff --git a/tinyusb/doxygen/group_def.txt b/tinyusb/doxygen/group_def.txt index cfc59d853..0f5419810 100644 --- a/tinyusb/doxygen/group_def.txt +++ b/tinyusb/doxygen/group_def.txt @@ -1,9 +1,22 @@ // define all the modules group to have the desired ordering since doxygen order module group by // the order of files it is feed +/// \defgroup group_demo Demos + /// \defgroup group_class Application - Class Driver API /// \defgroup group_application_api Application - Stack API /// \brief Non-Class driver API /// \defgroup group_configuration Configuration tusb_config.h + +/// \defgroup group_usbd USB Device Core (USBD) + +/// \defgroup group_usbh USB Host Core (USBH) + +/// \defgroup group_osal OS Abstraction Layer (OSAL) + +/// \defgroup group_usb_definitions USB Definitions + +/// \defgroup Group_Common Common Files + diff --git a/tinyusb/host/usbh.h b/tinyusb/host/usbh.h index f3e460dcf..eed50a538 100644 --- a/tinyusb/host/usbh.h +++ b/tinyusb/host/usbh.h @@ -36,7 +36,7 @@ */ /**************************************************************************/ -/** \defgroup group_usbh USB Host Core (USBH) +/** \ingroup group_usbh USB Host Core (USBH) * @{ */ #ifndef _TUSB_USBH_H_ diff --git a/tinyusb/osal/osal.h b/tinyusb/osal/osal.h index ebbade9d9..555f830ac 100644 --- a/tinyusb/osal/osal.h +++ b/tinyusb/osal/osal.h @@ -43,7 +43,7 @@ extern "C" {
#endif
-/** \defgroup group_osal OS Abstraction Layer (OSAL)
+/** \addtogroup group_osal
* @{ */
/** \defgroup group_supported_os Supported RTOS
|