diff options
| author | Dean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28> | 2011-02-20 13:08:29 +0000 |
|---|---|---|
| committer | Dean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28> | 2011-02-20 13:08:29 +0000 |
| commit | 7e5abe7ff1cc55f6f8a250f24cd5fcedeb3d2389 (patch) | |
| tree | f40fe1525f2053746540498041f1e8a819277bd7 /LUFA/Drivers/USB/Core/Events.h | |
| parent | e3f5648f950eea03feb39258930fde89d678b9c3 (diff) | |
Start update of documentation to support possible multiple architectures in the future - alter \file documentation to automatically copy in the module documentation where possible.
git-svn-id: http://lufa-lib.googlecode.com/svn/trunk@1673 d5102386-fcda-11dd-9fdb-3debd5008f28
Diffstat (limited to 'LUFA/Drivers/USB/Core/Events.h')
| -rw-r--r-- | LUFA/Drivers/USB/Core/Events.h | 16 |
1 files changed, 3 insertions, 13 deletions
diff --git a/LUFA/Drivers/USB/Core/Events.h b/LUFA/Drivers/USB/Core/Events.h index 4a3a1a16..c0a322b2 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 |