More documentation changes for better module-level documentation rather than file...

[pub/lufa.git] / LUFA / Drivers / USB / HighLevel / Events.h

diff --git a/LUFA/Drivers/USB/HighLevel/Events.h b/LUFA/Drivers/USB/HighLevel/Events.h
index 480e824..9638afe 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/Events.h
+++ b/LUFA/Drivers/USB/HighLevel/Events.h
@@ -28,22 +28,19 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

-/** Library events module. This module contains macros and functions relating to the management of library\r
- *  events, which are small pieces of code similar to ISRs which are run when a given condition is met. Each\r
- *  event can be fired from multiple places in the user or library code, which may or may not be inside an ISR,\r
- *  thus each handler should be written to be as small and fast as possible to prevent possible problems.\r
+/** \ingroup Group_USB\r
+ *  @defgroup Group_Events USB Events\r
+ *\r
+ *  This module contains macros and functions relating to the management of library events, which are small\r
+ *  pieces of code similar to ISRs which are run when a given condition is met. Each event can be fired from\r
+ *  multiple places in the user or library code, which may or may not be inside an ISR, thus each handler\r
+ *  should be written to be as small and fast as possible to prevent possible problems.\r

  *\r
  *  Events can be hooked by the user application using the EVENT_HANDLER() and HANDLES_EVENT() macros. If an\r
  *  event with no associated handler is fired within the library, it by default fires an internal empty stub\r
  *  function. This is achieved through the use of the GCC compiler's "alias" attribute.\r
  *\r
  *  Each event must only have one associated event handler, but can be raised by multiple sources.\r
  *\r
  *  Events can be hooked by the user application using the EVENT_HANDLER() and HANDLES_EVENT() macros. If an\r
  *  event with no associated handler is fired within the library, it by default fires an internal empty stub\r
  *  function. This is achieved through the use of the GCC compiler's "alias" attribute.\r
  *\r
  *  Each event must only have one associated event handler, but can be raised by multiple sources.\r

- */\r
-\r
-/** \ingroup Group_USB\r
- *  @defgroup Group_Events USB Events\r
- *\r
- *  Functions, macros, variables, enums and types related to the management of events from the USB kernel.\r

  *\r
  *  @{\r
  */\r
  *\r
  *  @{\r
  */\r