Added better USB Class driver overviews.
authorDean Camera <dean@fourwalledcubicle.com>
Thu, 27 Aug 2009 07:48:48 +0000 (07:48 +0000)
committerDean Camera <dean@fourwalledcubicle.com>
Thu, 27 Aug 2009 07:48:48 +0000 (07:48 +0000)
LUFA/Drivers/USB/Class/Audio.h
LUFA/Drivers/USB/Class/CDC.h
LUFA/Drivers/USB/Class/HID.h
LUFA/Drivers/USB/Class/MIDI.h
LUFA/Drivers/USB/Class/MassStorage.h
LUFA/Drivers/USB/Class/RNDIS.h
LUFA/Drivers/USB/Class/StillImage.h

index 2175a9b..0597bfd 100644 (file)
  *    - LUFA/Drivers/USB/Class/Host/Audio.c\r
  *\r
  *  \section Module Description\r
- *  Functions, macros, variables, enums and types related to the management of USB Audio Class interfaces\r
- *  within a USB device.\r
+ *  Audio Class Driver module. This module contains an internal implementation of the USB Audio Class, for both\r
+ *  Device and Host USB modes. User applications can use this class driver instead of implementing the Audio class\r
+ *  manually via the low-level LUFA APIs.\r
+ *\r
+ *  This module is designed to simplify the user code by exposing only the required interface needed to interace with\r
+ *  Hosts or Devices using the USB Audio Class.\r
  *\r
  *  @{\r
  */\r
index 9cd3bcd..8ed0cf6 100644 (file)
  *    - LUFA/Drivers/USB/Class/Host/CDC.c\r
  *\r
  *  \section Module Description\r
- *  Functions, macros, variables, enums and types related to the management of USB CDC Class interfaces\r
- *  within a USB device, for the implementation of CDC-ACM virtual serial ports.\r
+ *  CDC Class Driver module. This module contains an internal implementation of the USB CDC-ACM class Virtual Serial\r
+ *  Ports, for both Device and Host USB modes. User applications can use this class driver instead of implementing the\r
+ *  CDC class manually via the low-level LUFA APIs.\r
+ *\r
+ *  This module is designed to simplify the user code by exposing only the required interface needed to interace with\r
+ *  Hosts or Devices using the USB CDC Class.\r
  *\r
  *  @{\r
  */\r
index f8449b2..f1e2367 100644 (file)
  *    - LUFA/Drivers/USB/Class/Host/HIDParser.c\r
  *\r
  *  \section Module Description\r
- *  Functions, macros, variables, enums and types related to the management of USB HID Class interfaces\r
- *  within a USB device.\r
+ *  HID Class Driver module. This module contains an internal implementation of the USB HID Class, for both Device \r
+ *  and Host USB modes. User applications can use this class driver instead of implementing the HID class manually \r
+ *  via the low-level LUFA APIs.\r
+ *\r
+ *  This module is designed to simplify the user code by exposing only the required interface needed to interace with\r
+ *  Hosts or Devices using the USB HID Class.\r
  *\r
  *  @{\r
  */\r
index 8b68480..aa4daa2 100644 (file)
  *    - LUFA/Drivers/USB/Class/Host/MIDI.c\r
  *\r
  *  \section Module Description\r
- *  Functions, macros, variables, enums and types related to the management of USB MIDI Class interfaces\r
- *  within a USB device. Note that the MIDI class is actually a special case of the regular Audio class,\r
- *  thus this module depends on structure definitions from the \ref Group_USBClassAudioDevice class driver module.\r
+ *  MIDI Class Driver module. This module contains an internal implementation of the USB MIDI Class, for both Device\r
+ *  and Host USB modes. User applications can use this class driver instead of implementing the MIDI class manuall\r
+ *  via the low-level LUFA APIs.\r
+ *\r
+ *  This module is designed to simplify the user code by exposing only the required interface needed to interace with\r
+ *  Hosts or Devices using the USB MIDI Class.\r
+ *\r
+ *  \note The USB MIDI class is actually a special case of the regular Audio class, thus this module depends on\r
+ *        structure definitions from the \ref Group_USBClassAudioDevice class driver module.\r
  *\r
  *  @{\r
  */\r
index 5733b72..495a704 100644 (file)
  *    - LUFA/Drivers/USB/Class/Host/MassStorage.c\r
  *\r
  *  \section Module Description\r
- *  Functions, macros, variables, enums and types related to the management of USB Mass Storage Class interfaces\r
- *  within a USB device.\r
+ *  Mass Storage Class Driver module. This module contains an internal implementation of the USB Audio Class, for both\r
+ *  Device and Host USB modes. User applications can use this class driver instead of implementing the Mass Storage class\r
+ *  manually via the low-level LUFA APIs.\r
+ *\r
+ *  This module is designed to simplify the user code by exposing only the required interface needed to interace with\r
+ *  Hosts or Devices using the USB Mass Storage Class.\r
  *\r
  *  @{\r
  */\r
index 8709aa1..87616ae 100644 (file)
  *    - LUFA/Drivers/USB/Class/Device/RNDIS.c\r
  *\r
  *  \section Module Description\r
- *  Functions, macros, variables, enums and types related to the management of USB RNDIS Ethernet\r
- *  interfaces within a USB device.\r
+ *  RNDIS Class Driver module. This module contains an internal implementation of the Microsoft USB RNDIS Networking\r
+ *  Class, for Device USB mode only. User applications can use this class driver instead of implementing the RNDIS\r
+ *  class manually via the low-level LUFA APIs.\r
+ *\r
+ *  This module is designed to simplify the user code by exposing only the required interface needed to interace with\r
+ *  Hosts using the USB RNDIS Class.\r
  *\r
  *  @{\r
  */\r
index e023363..273b97a 100644 (file)
  *    - LUFA/Drivers/USB/Class/Host/StillImage.c\r
  *\r
  *  \section Module Description\r
- *  Functions, macros, variables, enums and types related to the management of USB Still Image Class interfaces\r
- *  within a USB device.\r
+ *  Still Image Class Driver module. This module contains an internal implementation of the USB Still Image Class,\r
+ *  for USB Host mode only. User applications can use this class driver instead of implementing the Still Image class\r
+ *  manually via the low-level LUFA APIs.\r
+ *\r
+ *  This module is designed to simplify the user code by exposing only the required interface needed to interace with\r
+ *  Devices using the USB Still Image Class.\r
  *\r
  *  @{\r
  */\r