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

6 files changed, 17 insertions, 45 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.

  *

  *  @{

  */

diff --git a/LUFA/Drivers/USB/HighLevel/StdDescriptors.h b/LUFA/Drivers/USB/HighLevel/StdDescriptors.h
index a1a051824..431080b72 100644
--- a/LUFA/Drivers/USB/HighLevel/StdDescriptors.h
+++ b/LUFA/Drivers/USB/HighLevel/StdDescriptors.h
@@ -28,7 +28,8 @@
   this software.

 */

 

-/** \file

+/** \ingroup Group_USB

+ *  @defgroup Group_Descriptors USB Descriptors

  *

  *  Standard USB device descriptor defines and retrieval routines, for USB devices. This module contains

  *  structures and macros for the easy creation of standard USB descriptors in USB device projects.

@@ -42,12 +43,6 @@
  *  descriptors will contain elements named identically to the official USB specification. The alternately

  *  named descriptor elements are placed in the same order inside the descriptor structures as their officially

  *  named counterparts, thus they can be correlated easily with the official USB specification.

- */

-

-/** \ingroup Group_USB

- *  @defgroup Group_Descriptors USB Descriptors

- *

- *  Functions, macros, variables, enums and types related to standard USB descriptors.

  *

  *  @{

  */

diff --git a/LUFA/Drivers/USB/HighLevel/StdRequestType.h b/LUFA/Drivers/USB/HighLevel/StdRequestType.h
index bf9ef8aee..27c179497 100644
--- a/LUFA/Drivers/USB/HighLevel/StdRequestType.h
+++ b/LUFA/Drivers/USB/HighLevel/StdRequestType.h
@@ -28,16 +28,11 @@
   this software.

 */

 

-/** \file

- *

- *  Contains definitions for the various control request parameters, so that the request details (such as data

- *  direction, request recipient, etc.) can be extracted via masking.

- */

- 

 /** \ingroup Group_USB

  *  @defgroup Group_StdRequest Standard USB Requests

  *

- *  Functions, macros, variables, enums and types related to standard USB requests to USB devices.

+ *  This module contains definitions for the various control request parameters, so that the request

+ *   details (such as data direction, request recipient, etc.) can be extracted via masking.

  *

  *  @{

  */

diff --git a/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h b/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h
index 300a3f217..26f150350 100644
--- a/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h
+++ b/LUFA/Drivers/USB/HighLevel/StreamCallbacks.h
@@ -27,18 +27,13 @@
   arising out of or in connection with the use or performance of

   this software.

 */

-

-/** \file

- *

- *  Macros and enums for the stream callback routines in Endpoint.h and Pipe.c. This module contains the

- *  code required to easily set up stream callback functions which can be used to force early abort of a

- *  stream read/write process.

- */

  

 /** \ingroup Group_USB

  *  @defgroup Group_StreamCallbacks Endpoint and Pipe Stream Callbacks

  *

- *  Functions, macros, variables, enums and types related to endpoint and pipe stream callback functions.

+ *  Macros and enums for the stream callback routines in Endpoint.h and Pipe.c. This module contains the

+ *  code required to easily set up stream callback functions which can be used to force early abort of a

+ *  stream read/write process.

  *

  *  @{

  */

diff --git a/LUFA/Drivers/USB/HighLevel/USBInterrupt.h b/LUFA/Drivers/USB/HighLevel/USBInterrupt.h
index 65e0b5fb1..56297e3d4 100644
--- a/LUFA/Drivers/USB/HighLevel/USBInterrupt.h
+++ b/LUFA/Drivers/USB/HighLevel/USBInterrupt.h
@@ -28,16 +28,12 @@
   this software.

 */

 

-/** \file

- *

- *  Main USB interrupt vector handler. This file manages the main USB interrupt vector, for handling such

- *  events as VBUS interrupts (on supported USB AVR models), device connections and disconnections, etc.

- */

-

 /** \ingroup Group_USB

  *  @defgroup Group_USBInterrupt Endpoint and Pipe Interrupts

  *

- *  Functions, macros, variables, enums and types related to endpoint and pipe interrupts.

+ *  Main USB interrupt vector handler. This file manages the main USB interrupt vector, for handling such

+ *  events as VBUS interrupts (on supported USB AVR models), device connections and disconnections, etc.

+ *  as well as providing easy to use macros for the management of the Endpoint/Pipe interrupt vector.

  *

  *  @{

  */

diff --git a/LUFA/Drivers/USB/HighLevel/USBTask.h b/LUFA/Drivers/USB/HighLevel/USBTask.h
index bcf117ddb..637872291 100644
--- a/LUFA/Drivers/USB/HighLevel/USBTask.h
+++ b/LUFA/Drivers/USB/HighLevel/USBTask.h
@@ -27,12 +27,6 @@
   arising out of or in connection with the use or performance of

   this software.

 */

-

-/** \file

- *

- *  Main library USB management task for both Host and Device mode operations. This contains the master

- *  USB_USBTask task which should be periodically run to service both host and device USB projects.

- */

  

 #ifndef __USBTASK_H__

 #define __USBTASK_H__