Add file-level brief documentation.

Remove accidentally duplicated model-specific peripheral driver files.
This commit is contained in:
Dean Camera 2010-03-29 07:49:58 +00:00
parent ec19436d54
commit 0557676013
111 changed files with 1039 additions and 453 deletions

View file

@ -28,6 +28,25 @@
this software.
*/
/** \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).
*
* \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.
*/
/** \ingroup Group_USB
* @defgroup Group_Events USB Events
*