summaryrefslogtreecommitdiff
path: root/tinyusb/common/errors.h
diff options
context:
space:
mode:
authorhathach <[email protected]>2012-11-29 15:35:59 +0700
committerhathach <[email protected]>2012-11-29 15:35:59 +0700
commit360b28b44fa2ad7973f06c7f048a66a68e6cb90f (patch)
treea80ef4f6ba6282faa2fd13cc18689667f47626e9 /tinyusb/common/errors.h
parent382cd30be2e3069a490977e1a492783188a02da0 (diff)
add more doxygen docs
start to use TUSB_Error_t
Diffstat (limited to 'tinyusb/common/errors.h')
-rw-r--r--tinyusb/common/errors.h14
1 files changed, 11 insertions, 3 deletions
diff --git a/tinyusb/common/errors.h b/tinyusb/common/errors.h
index 20a797792..0d36b56fc 100644
--- a/tinyusb/common/errors.h
+++ b/tinyusb/common/errors.h
@@ -42,23 +42,29 @@
*/
/** \ingroup Group_Common
- *
+ * \defgroup Group_Error tinyUSB Error Codes
* @{
*/
#ifndef _TUSB_ERRORS_H_
#define _TUSB_ERRORS_H_
-enum TUSB_ERROR {
+/** \enum TUSB_Error
+ * \brief Error Code returned
+ */
+
+typedef enum {
# define ERROR_ENUM(x) x,
# include "errors_def"
# undef ERROR_ENUM
-};
+ ERROR_COUNT
+}TUSB_Error_t;
#ifdef __cplusplus
extern "C" {
#endif
+/// Enum to String for debugging purposes. Only available if \ref CFG_TUSB_DEBUG_LEVEL > 0
extern char const* const TUSB_ErrorStr[];
#ifdef __cplusplus
@@ -66,3 +72,5 @@ extern char const* const TUSB_ErrorStr[];
#endif
#endif /* _TUSB_ERRORS_H_ */
+
+ /** @{ */