summaryrefslogtreecommitdiff
path: root/tinyusb/host
diff options
context:
space:
mode:
authorhathach <[email protected]>2012-11-29 16:58:12 +0700
committerhathach <[email protected]>2012-11-29 16:58:12 +0700
commit2dd9501f37b8e2b2fdfa43b12469498646ae3fe5 (patch)
treedd102e40841da02a0dfc05c90a449774f7f8f876 /tinyusb/host
parentb8b92e120220ee19f623809673323344e257bd4b (diff)
update doxygen
Diffstat (limited to 'tinyusb/host')
-rw-r--r--tinyusb/host/hcd.h23
1 files changed, 23 insertions, 0 deletions
diff --git a/tinyusb/host/hcd.h b/tinyusb/host/hcd.h
index 64bf28205..d807341ec 100644
--- a/tinyusb/host/hcd.h
+++ b/tinyusb/host/hcd.h
@@ -35,6 +35,19 @@
* This file is part of the tiny usb stack.
*/
+/** \file
+ * \brief Host Controller Driver
+ *
+ * \note TBD
+ */
+
+/** \ingroup Group_TinyUSB
+ * \defgroup Group_HCD Host Controller Driver
+ * \brief Host Controller Driver
+ *
+ * @{
+ */
+
#ifndef _TUSB_HCD_H_
#define _TUSB_HCD_H_
@@ -44,6 +57,14 @@
extern "C" {
#endif
+/** \brief Initialize HCD
+*
+* \param[in] para1
+* \param[out] para2
+* \return Error Code of the \ref TUSB_ERROR enum
+* \note
+*/
+
TUSB_Error_t hcd_init() ATTR_WARN_UNUSED_RESULT;
#ifdef __cplusplus
@@ -51,3 +72,5 @@ TUSB_Error_t hcd_init() ATTR_WARN_UNUSED_RESULT;
#endif
#endif /* _TUSB_HCD_H_ */
+
+/// @}