aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/USB/Core/Events.h
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2011-02-20 13:08:29 +0000
committerDean Camera <dean@fourwalledcubicle.com>2011-02-20 13:08:29 +0000
commit5e7319058268e021ae39ca4b9fcabaec0060117b (patch)
treef40fe1525f2053746540498041f1e8a819277bd7 /LUFA/Drivers/USB/Core/Events.h
parent1daa5e16f9a395fb2943906a715adb35b8106988 (diff)
downloadlufa-5e7319058268e021ae39ca4b9fcabaec0060117b.tar.gz
lufa-5e7319058268e021ae39ca4b9fcabaec0060117b.tar.bz2
lufa-5e7319058268e021ae39ca4b9fcabaec0060117b.zip
Start update of documentation to support possible multiple architectures in the future - alter \file documentation to automatically copy in the module documentation where possible.
Diffstat (limited to 'LUFA/Drivers/USB/Core/Events.h')
-rw-r--r--LUFA/Drivers/USB/Core/Events.h16
1 files changed, 3 insertions, 13 deletions
diff --git a/LUFA/Drivers/USB/Core/Events.h b/LUFA/Drivers/USB/Core/Events.h
index 4a3a1a160..c0a322b26 100644
--- a/LUFA/Drivers/USB/Core/Events.h
+++ b/LUFA/Drivers/USB/Core/Events.h
@@ -29,19 +29,8 @@
*/
/** \file
- * \brief USB controller events manager.
- *
- * This file contains macros and functions relating to the management of library events, which are small
- * pieces of code similar to ISRs which are run when a given condition is met. Each event can be fired from
- * multiple places in the user or library code, which may or may not be inside an ISR, thus each handler
- * should be written to be as small and fast as possible to prevent possible problems.
- *
- * Events can be hooked by the user application by declaring a handler function with the same name and parameters
- * listed here. If an event with no user-associated handler is fired within the library, it by default maps to an
- * internal empty stub function.
- *
- * Each event must only have one associated event handler, but can be raised by multiple sources by calling the
- * event handler function (with any required event parameters).
+ * \brief USB Event management definitions.
+ * \copydetails Group_Events
*
* \note This file should not be included directly. It is automatically included as needed by the USB driver
* dispatch header located in LUFA/Drivers/USB/USB.h.
@@ -49,6 +38,7 @@
/** \ingroup Group_USB
* \defgroup Group_Events USB Events
+ * \brief USB Event management definitions.
*
* This module contains macros and functions relating to the management of library events, which are small
* pieces of code similar to ISRs which are run when a given condition is met. Each event can be fired from