aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/USB/HighLevel/Events.h
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2009-04-17 05:04:21 +0000
committerDean Camera <dean@fourwalledcubicle.com>2009-04-17 05:04:21 +0000
commitd38fa49cb6cb3804c9bb17601688a62ba466b535 (patch)
tree15e7fc6164e77ceb6e415e9a70a8fd8068880702 /LUFA/Drivers/USB/HighLevel/Events.h
parent6380d057f8911f5d09bdffff4220aa9602df49e2 (diff)
downloadlufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.tar.gz
lufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.tar.bz2
lufa-d38fa49cb6cb3804c9bb17601688a62ba466b535.zip
More documentation changes for better module-level documentation rather than file-level documentation.
Diffstat (limited to 'LUFA/Drivers/USB/HighLevel/Events.h')
-rw-r--r--LUFA/Drivers/USB/HighLevel/Events.h17
1 files changed, 7 insertions, 10 deletions
diff --git a/LUFA/Drivers/USB/HighLevel/Events.h b/LUFA/Drivers/USB/HighLevel/Events.h
index 480e824a7..9638afee3 100644
--- a/LUFA/Drivers/USB/HighLevel/Events.h
+++ b/LUFA/Drivers/USB/HighLevel/Events.h
@@ -28,22 +28,19 @@
this software.
*/
-/** Library events module. 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 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.
+/** \ingroup Group_USB
+ * @defgroup Group_Events USB Events
+ *
+ * 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
+ * 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 using the EVENT_HANDLER() and HANDLES_EVENT() macros. If an
* event with no associated handler is fired within the library, it by default fires an internal empty stub
* function. This is achieved through the use of the GCC compiler's "alias" attribute.
*
* Each event must only have one associated event handler, but can be raised by multiple sources.
- */
-
-/** \ingroup Group_USB
- * @defgroup Group_Events USB Events
- *
- * Functions, macros, variables, enums and types related to the management of events from the USB kernel.
*
* @{
*/