From 2dd9501f37b8e2b2fdfa43b12469498646ae3fe5 Mon Sep 17 00:00:00 2001 From: hathach Date: Thu, 29 Nov 2012 16:58:12 +0700 Subject: update doxygen --- tinyusb/host/hcd.h | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) (limited to 'tinyusb/host') 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_ */ + +/// @} -- cgit v1.3.1