From cd2dcc9163c6a77c5f358ed27692962dd5b6b214 Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Thu, 27 Aug 2009 07:48:48 +0000
Subject: [PATCH] Added better USB Class driver overviews.
---
LUFA/Drivers/USB/Class/Audio.h | 8 ++++++--
LUFA/Drivers/USB/Class/CDC.h | 8 ++++++--
LUFA/Drivers/USB/Class/HID.h | 8 ++++++--
LUFA/Drivers/USB/Class/MIDI.h | 12 +++++++++---
LUFA/Drivers/USB/Class/MassStorage.h | 8 ++++++--
LUFA/Drivers/USB/Class/RNDIS.h | 8 ++++++--
LUFA/Drivers/USB/Class/StillImage.h | 8 ++++++--
7 files changed, 45 insertions(+), 15 deletions(-)
diff --git a/LUFA/Drivers/USB/Class/Audio.h b/LUFA/Drivers/USB/Class/Audio.h
index 2175a9ba6..0597bfd5c 100644
--- a/LUFA/Drivers/USB/Class/Audio.h
+++ b/LUFA/Drivers/USB/Class/Audio.h
@@ -37,8 +37,12 @@
* - LUFA/Drivers/USB/Class/Host/Audio.c
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the management of USB Audio Class interfaces
- * within a USB device.
+ * Audio Class Driver module. This module contains an internal implementation of the USB Audio Class, for both
+ * Device and Host USB modes. User applications can use this class driver instead of implementing the Audio class
+ * manually via the low-level LUFA APIs.
+ *
+ * This module is designed to simplify the user code by exposing only the required interface needed to interace with
+ * Hosts or Devices using the USB Audio Class.
*
* @{
*/
diff --git a/LUFA/Drivers/USB/Class/CDC.h b/LUFA/Drivers/USB/Class/CDC.h
index 9cd3bcdea..8ed0cf671 100644
--- a/LUFA/Drivers/USB/Class/CDC.h
+++ b/LUFA/Drivers/USB/Class/CDC.h
@@ -37,8 +37,12 @@
* - LUFA/Drivers/USB/Class/Host/CDC.c
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the management of USB CDC Class interfaces
- * within a USB device, for the implementation of CDC-ACM virtual serial ports.
+ * CDC Class Driver module. This module contains an internal implementation of the USB CDC-ACM class Virtual Serial
+ * Ports, for both Device and Host USB modes. User applications can use this class driver instead of implementing the
+ * CDC class manually via the low-level LUFA APIs.
+ *
+ * This module is designed to simplify the user code by exposing only the required interface needed to interace with
+ * Hosts or Devices using the USB CDC Class.
*
* @{
*/
diff --git a/LUFA/Drivers/USB/Class/HID.h b/LUFA/Drivers/USB/Class/HID.h
index f8449b20e..f1e23678d 100644
--- a/LUFA/Drivers/USB/Class/HID.h
+++ b/LUFA/Drivers/USB/Class/HID.h
@@ -38,8 +38,12 @@
* - LUFA/Drivers/USB/Class/Host/HIDParser.c
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the management of USB HID Class interfaces
- * within a USB device.
+ * HID Class Driver module. This module contains an internal implementation of the USB HID Class, for both Device
+ * and Host USB modes. User applications can use this class driver instead of implementing the HID class manually
+ * via the low-level LUFA APIs.
+ *
+ * This module is designed to simplify the user code by exposing only the required interface needed to interace with
+ * Hosts or Devices using the USB HID Class.
*
* @{
*/
diff --git a/LUFA/Drivers/USB/Class/MIDI.h b/LUFA/Drivers/USB/Class/MIDI.h
index 8b68480d3..aa4daa210 100644
--- a/LUFA/Drivers/USB/Class/MIDI.h
+++ b/LUFA/Drivers/USB/Class/MIDI.h
@@ -37,9 +37,15 @@
* - LUFA/Drivers/USB/Class/Host/MIDI.c
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the management of USB MIDI Class interfaces
- * within a USB device. Note that the MIDI class is actually a special case of the regular Audio class,
- * thus this module depends on structure definitions from the \ref Group_USBClassAudioDevice class driver module.
+ * MIDI Class Driver module. This module contains an internal implementation of the USB MIDI Class, for both Device
+ * and Host USB modes. User applications can use this class driver instead of implementing the MIDI class manuall
+ * via the low-level LUFA APIs.
+ *
+ * This module is designed to simplify the user code by exposing only the required interface needed to interace with
+ * Hosts or Devices using the USB MIDI Class.
+ *
+ * \note The USB MIDI class is actually a special case of the regular Audio class, thus this module depends on
+ * structure definitions from the \ref Group_USBClassAudioDevice class driver module.
*
* @{
*/
diff --git a/LUFA/Drivers/USB/Class/MassStorage.h b/LUFA/Drivers/USB/Class/MassStorage.h
index 5733b7225..495a704ab 100644
--- a/LUFA/Drivers/USB/Class/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/MassStorage.h
@@ -37,8 +37,12 @@
* - LUFA/Drivers/USB/Class/Host/MassStorage.c
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the management of USB Mass Storage Class interfaces
- * within a USB device.
+ * Mass Storage Class Driver module. This module contains an internal implementation of the USB Audio Class, for both
+ * Device and Host USB modes. User applications can use this class driver instead of implementing the Mass Storage class
+ * manually via the low-level LUFA APIs.
+ *
+ * This module is designed to simplify the user code by exposing only the required interface needed to interace with
+ * Hosts or Devices using the USB Mass Storage Class.
*
* @{
*/
diff --git a/LUFA/Drivers/USB/Class/RNDIS.h b/LUFA/Drivers/USB/Class/RNDIS.h
index 8709aa12e..87616ae14 100644
--- a/LUFA/Drivers/USB/Class/RNDIS.h
+++ b/LUFA/Drivers/USB/Class/RNDIS.h
@@ -36,8 +36,12 @@
* - LUFA/Drivers/USB/Class/Device/RNDIS.c
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the management of USB RNDIS Ethernet
- * interfaces within a USB device.
+ * RNDIS Class Driver module. This module contains an internal implementation of the Microsoft USB RNDIS Networking
+ * Class, for Device USB mode only. User applications can use this class driver instead of implementing the RNDIS
+ * class manually via the low-level LUFA APIs.
+ *
+ * This module is designed to simplify the user code by exposing only the required interface needed to interace with
+ * Hosts using the USB RNDIS Class.
*
* @{
*/
diff --git a/LUFA/Drivers/USB/Class/StillImage.h b/LUFA/Drivers/USB/Class/StillImage.h
index e02336370..273b97a77 100644
--- a/LUFA/Drivers/USB/Class/StillImage.h
+++ b/LUFA/Drivers/USB/Class/StillImage.h
@@ -36,8 +36,12 @@
* - LUFA/Drivers/USB/Class/Host/StillImage.c
*
* \section Module Description
- * Functions, macros, variables, enums and types related to the management of USB Still Image Class interfaces
- * within a USB device.
+ * Still Image Class Driver module. This module contains an internal implementation of the USB Still Image Class,
+ * for USB Host mode only. User applications can use this class driver instead of implementing the Still Image class
+ * manually via the low-level LUFA APIs.
+ *
+ * This module is designed to simplify the user code by exposing only the required interface needed to interace with
+ * Devices using the USB Still Image Class.
*
* @{
*/
--
GitLab