Start update of documentation to support possible multiple architectures in the future - alter \file documentation to automatically copy in the module documentation where possible.
This commit is contained in:
parent
1daa5e16f9
commit
5e73190582
98 changed files with 256 additions and 590 deletions
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue