summaryrefslogtreecommitdiff
path: root/tinyusb/host
diff options
context:
space:
mode:
authorhathach <[email protected]>2014-03-16 22:20:33 +0700
committerhathach <[email protected]>2014-03-16 22:20:33 +0700
commitd1d4ddd85626567ddd0369387276ccf9680673d6 (patch)
tree7bded70898796d0219c2245f6dabe6bdfdb7fbac /tinyusb/host
parent18d577abfb3feb3c4eb2728661b6c508cdf37da0 (diff)
doxygen document
Diffstat (limited to 'tinyusb/host')
-rw-r--r--tinyusb/host/ehci/ehci.h2
-rw-r--r--tinyusb/host/hcd.h11
-rw-r--r--tinyusb/host/hub.h2
-rw-r--r--tinyusb/host/ohci/ohci.h5
-rw-r--r--tinyusb/host/usbh.h7
-rw-r--r--tinyusb/host/usbh_hcd.h13
6 files changed, 13 insertions, 27 deletions
diff --git a/tinyusb/host/ehci/ehci.h b/tinyusb/host/ehci/ehci.h
index 1d7db7c95..b6500d31f 100644
--- a/tinyusb/host/ehci/ehci.h
+++ b/tinyusb/host/ehci/ehci.h
@@ -36,7 +36,7 @@
*/
/**************************************************************************/
-/** \ingroup Port_HCD
+/** \ingroup Group_HCD
* @{
* \defgroup EHCI
* \brief EHCI driver. All documents sources mentioned here (eg section 3.5) is referring to EHCI Specs unless state otherwise
diff --git a/tinyusb/host/hcd.h b/tinyusb/host/hcd.h
index c148ccb88..eacda4257 100644
--- a/tinyusb/host/hcd.h
+++ b/tinyusb/host/hcd.h
@@ -36,11 +36,9 @@
*/
/**************************************************************************/
-/** \addtogroup Port Port
- * @{
- * \defgroup Port_HCD Host Controller Driver (HCD)
- * @{
- */
+/** \ingroup Group_USBH
+ * \defgroup Group_HCD Host Controller Driver (HCD)
+ * @{ */
#ifndef _TUSB_HCD_H_
#define _TUSB_HCD_H_
@@ -116,7 +114,6 @@ void hcd_port_unplug(uint8_t hostid); // called by usbh to instruct hcd that it
}
#endif
- #endif /* _TUSB_HCD_H_ */
+#endif /* _TUSB_HCD_H_ */
/// @}
-/// @}
diff --git a/tinyusb/host/hub.h b/tinyusb/host/hub.h
index 956dee505..6097e15e3 100644
--- a/tinyusb/host/hub.h
+++ b/tinyusb/host/hub.h
@@ -38,7 +38,7 @@
/** \addtogroup ClassDriver
* @{
- * \defgroup ClassDriver_Hub Hub (Host)
+ * \defgroup ClassDriver_Hub Hub (Host only)
* \details Like most PC's OS, Hub support is completely hidden from Application. In fact, application cannot determine whether
* a device is mounted directly via roothub or via a hub's port. All Hub-related procedures are performed and managed
* by tinyusb stack. Unless you are trying to develop the stack itself, there are nothing else can be used by Application.
diff --git a/tinyusb/host/ohci/ohci.h b/tinyusb/host/ohci/ohci.h
index f03ef94b9..eed6909a2 100644
--- a/tinyusb/host/ohci/ohci.h
+++ b/tinyusb/host/ohci/ohci.h
@@ -36,12 +36,11 @@
*/
/**************************************************************************/
-/** \ingroup Port_HCD
+/** \ingroup Group_HCD
* @{
* \defgroup OHCI
* \brief OHCI driver. All documents sources mentioned here (eg section 3.5) is referring to OHCI Specs unless state otherwise
- * @{
- */
+ * @{ */
#ifndef _TUSB_OHCI_H_
#define _TUSB_OHCI_H_
diff --git a/tinyusb/host/usbh.h b/tinyusb/host/usbh.h
index d828d4bb2..467ab6e95 100644
--- a/tinyusb/host/usbh.h
+++ b/tinyusb/host/usbh.h
@@ -36,12 +36,9 @@
*/
/**************************************************************************/
-/** \ingroup TBD
- * \defgroup TBD
+/** \defgroup Group_USBH USB Host Driver (USBH)
* \brief TBD
- *
- * @{
- */
+ * @{ */
#ifndef _TUSB_USBD_HOST_H_
#define _TUSB_USBD_HOST_H_
diff --git a/tinyusb/host/usbh_hcd.h b/tinyusb/host/usbh_hcd.h
index 305b0eb42..bdeb04713 100644
--- a/tinyusb/host/usbh_hcd.h
+++ b/tinyusb/host/usbh_hcd.h
@@ -36,18 +36,11 @@
*/
/**************************************************************************/
-/** \file
- * \brief TBD
- *
- * \note TBD
- */
-
-/** \ingroup TBD
+/** \ingroup Group_HCD
+ * @{
* \defgroup TBD
* \brief TBD
- *
- * @{
- */
+ * @{ */
#ifndef _TUSB_USBH_HCD_H_
#define _TUSB_USBH_HCD_H_