From 0557676013f41487701a8951d3dbb4aee3117882 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Mon, 29 Mar 2010 07:49:58 +0000 Subject: Add file-level brief documentation. Remove accidentally duplicated model-specific peripheral driver files. --- LUFA/Drivers/USB/Class/Audio.h | 7 +++++++ LUFA/Drivers/USB/Class/CDC.h | 9 ++++++++- LUFA/Drivers/USB/Class/Common/Audio.h | 7 +++++++ LUFA/Drivers/USB/Class/Common/CDC.h | 7 +++++++ LUFA/Drivers/USB/Class/Common/HID.h | 7 +++++++ LUFA/Drivers/USB/Class/Common/MIDI.h | 7 +++++++ LUFA/Drivers/USB/Class/Common/MassStorage.h | 7 +++++++ LUFA/Drivers/USB/Class/Common/Printer.h | 7 +++++++ LUFA/Drivers/USB/Class/Common/RNDIS.h | 7 +++++++ LUFA/Drivers/USB/Class/Common/RNDISConstants.h | 7 +++++++ LUFA/Drivers/USB/Class/Common/StillImage.h | 7 +++++++ LUFA/Drivers/USB/Class/Device/Audio.h | 7 +++++++ LUFA/Drivers/USB/Class/Device/CDC.h | 7 +++++++ LUFA/Drivers/USB/Class/Device/HID.h | 7 +++++++ LUFA/Drivers/USB/Class/Device/MIDI.h | 7 +++++++ LUFA/Drivers/USB/Class/Device/MassStorage.h | 7 +++++++ LUFA/Drivers/USB/Class/Device/RNDIS.h | 7 +++++++ LUFA/Drivers/USB/Class/HID.h | 7 +++++++ LUFA/Drivers/USB/Class/Host/CDC.h | 7 +++++++ LUFA/Drivers/USB/Class/Host/HID.h | 7 +++++++ LUFA/Drivers/USB/Class/Host/HIDParser.h | 7 ++++--- LUFA/Drivers/USB/Class/Host/HIDReportData.h | 4 ++-- LUFA/Drivers/USB/Class/Host/MIDI.h | 7 +++++++ LUFA/Drivers/USB/Class/Host/MassStorage.h | 7 +++++++ LUFA/Drivers/USB/Class/Host/Printer.h | 7 +++++++ LUFA/Drivers/USB/Class/Host/RNDIS.h | 7 +++++++ LUFA/Drivers/USB/Class/Host/StillImage.c | 3 ++- LUFA/Drivers/USB/Class/Host/StillImage.h | 7 +++++++ LUFA/Drivers/USB/Class/MIDI.h | 7 +++++++ LUFA/Drivers/USB/Class/MassStorage.h | 7 +++++++ LUFA/Drivers/USB/Class/Printer.h | 7 +++++++ LUFA/Drivers/USB/Class/RNDIS.h | 9 ++++++++- LUFA/Drivers/USB/Class/StillImage.h | 7 +++++++ 33 files changed, 220 insertions(+), 8 deletions(-) (limited to 'LUFA/Drivers/USB/Class') diff --git a/LUFA/Drivers/USB/Class/Audio.h b/LUFA/Drivers/USB/Class/Audio.h index c6a926337..3c7e66535 100644 --- a/LUFA/Drivers/USB/Class/Audio.h +++ b/LUFA/Drivers/USB/Class/Audio.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Master include file for the library USB Audio Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers * @defgroup Group_USBClassAudio Audio Class Driver - LUFA/Drivers/Class/Audio.h * diff --git a/LUFA/Drivers/USB/Class/CDC.h b/LUFA/Drivers/USB/Class/CDC.h index cc49572b2..22e534368 100644 --- a/LUFA/Drivers/USB/Class/CDC.h +++ b/LUFA/Drivers/USB/Class/CDC.h @@ -28,8 +28,15 @@ this software. */ +/** \file + * \brief Master include file for the library USB CDC-ACM Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers - * @defgroup Group_USBClassCDC CDC Class Driver - LUFA/Drivers/Class/CDC.h + * @defgroup Group_USBClassCDC CDC-ACM (Virtual Serial) Class Driver - LUFA/Drivers/Class/CDC.h * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: diff --git a/LUFA/Drivers/USB/Class/Common/Audio.h b/LUFA/Drivers/USB/Class/Common/Audio.h index 5d19b6f42..a6a1b4070 100644 --- a/LUFA/Drivers/USB/Class/Common/Audio.h +++ b/LUFA/Drivers/USB/Class/Common/Audio.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB Audio Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Audio.h. + */ + /** \ingroup Group_USBClassAudio * @defgroup Group_USBClassAudioCommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/CDC.h b/LUFA/Drivers/USB/Class/Common/CDC.h index 55f530ba9..bb1996b6c 100644 --- a/LUFA/Drivers/USB/Class/Common/CDC.h +++ b/LUFA/Drivers/USB/Class/Common/CDC.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB CDC Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/CDC.h. + */ + /** \ingroup Group_USBClassCDC * @defgroup Group_USBClassCDCCommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/HID.h b/LUFA/Drivers/USB/Class/Common/HID.h index 33a5af4ac..cf457cb86 100644 --- a/LUFA/Drivers/USB/Class/Common/HID.h +++ b/LUFA/Drivers/USB/Class/Common/HID.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB HID Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/HID.h. + */ + /** \ingroup Group_USBClassHID * @defgroup Group_USBClassHIDCommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/MIDI.h b/LUFA/Drivers/USB/Class/Common/MIDI.h index 755006a70..72a72de38 100644 --- a/LUFA/Drivers/USB/Class/Common/MIDI.h +++ b/LUFA/Drivers/USB/Class/Common/MIDI.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB MIDI Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/MIDI.h. + */ + /** \ingroup Group_USBClassMIDI * @defgroup Group_USBClassMIDICommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/MassStorage.h b/LUFA/Drivers/USB/Class/Common/MassStorage.h index 8726148a2..7f321350f 100644 --- a/LUFA/Drivers/USB/Class/Common/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Common/MassStorage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB Mass Storage Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h. + */ + /** \ingroup Group_USBClassMS * @defgroup Group_USBClassMSCommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/Printer.h b/LUFA/Drivers/USB/Class/Common/Printer.h index 06ec0bb0b..f78cbaafa 100644 --- a/LUFA/Drivers/USB/Class/Common/Printer.h +++ b/LUFA/Drivers/USB/Class/Common/Printer.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB Printer Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Printer.h. + */ + /** \ingroup Group_USBClassMS * @defgroup Group_USBClassPrinterCommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/RNDIS.h b/LUFA/Drivers/USB/Class/Common/RNDIS.h index 258604deb..b69142c98 100644 --- a/LUFA/Drivers/USB/Class/Common/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Common/RNDIS.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB RNDIS Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h. + */ + /** \ingroup Group_USBClassRNDIS * @defgroup Group_USBClassRNDISCommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Common/RNDISConstants.h b/LUFA/Drivers/USB/Class/Common/RNDISConstants.h index 67fa78a0d..b65040e1b 100644 --- a/LUFA/Drivers/USB/Class/Common/RNDISConstants.h +++ b/LUFA/Drivers/USB/Class/Common/RNDISConstants.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common RNDIS class constant definitions. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Audio.h. + */ + /** \file * * RNDIS specification related constants. For more information on these diff --git a/LUFA/Drivers/USB/Class/Common/StillImage.h b/LUFA/Drivers/USB/Class/Common/StillImage.h index e65b2dbfd..4b0faac35 100644 --- a/LUFA/Drivers/USB/Class/Common/StillImage.h +++ b/LUFA/Drivers/USB/Class/Common/StillImage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Common definitions and declarations for the library USB Still Image Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/StillImage.h. + */ + /** \ingroup Group_USBClassSI * @defgroup Group_USBClassSICommon Common Class Definitions * diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h index 87fab9889..9677339ca 100644 --- a/LUFA/Drivers/USB/Class/Device/Audio.h +++ b/LUFA/Drivers/USB/Class/Device/Audio.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Device mode driver for the library USB Audio Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Audio.h. + */ + /** \ingroup Group_USBClassAudio * @defgroup Group_USBClassAudioDevice Audio Class Device Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h index 0c214441c..adf1708ce 100644 --- a/LUFA/Drivers/USB/Class/Device/CDC.h +++ b/LUFA/Drivers/USB/Class/Device/CDC.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Device mode driver for the library USB CDC Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/CDC.h. + */ + /** \ingroup Group_USBClassCDC * @defgroup Group_USBClassCDCDevice CDC Class Device Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h index 15b428a7b..009018437 100644 --- a/LUFA/Drivers/USB/Class/Device/HID.h +++ b/LUFA/Drivers/USB/Class/Device/HID.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Device mode driver for the library USB HID Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/HID.h. + */ + /** \ingroup Group_USBClassHID * @defgroup Group_USBClassHIDDevice HID Class Device Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h index 772456bc1..9eaabbc5e 100644 --- a/LUFA/Drivers/USB/Class/Device/MIDI.h +++ b/LUFA/Drivers/USB/Class/Device/MIDI.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Device mode driver for the library USB MIDI Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/MIDI.h. + */ + /** \ingroup Group_USBClassMIDI * @defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Device/MassStorage.h b/LUFA/Drivers/USB/Class/Device/MassStorage.h index 87dcfb232..67bbfab91 100644 --- a/LUFA/Drivers/USB/Class/Device/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Device/MassStorage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Device mode driver for the library USB Mass Storage Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h. + */ + /** \ingroup Group_USBClassMS * @defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Device/RNDIS.h b/LUFA/Drivers/USB/Class/Device/RNDIS.h index 7d6b3a882..5d541f18b 100644 --- a/LUFA/Drivers/USB/Class/Device/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Device/RNDIS.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Device mode driver for the library USB RNDIS Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h. + */ + /** \ingroup Group_USBClassRNDIS * @defgroup Group_USBClassRNDISDevice RNDIS Class Device Mode Driver * diff --git a/LUFA/Drivers/USB/Class/HID.h b/LUFA/Drivers/USB/Class/HID.h index 5eda33b2a..3a7fe2121 100644 --- a/LUFA/Drivers/USB/Class/HID.h +++ b/LUFA/Drivers/USB/Class/HID.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Master include file for the library USB HID Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers * @defgroup Group_USBClassHID HID Class Driver - LUFA/Drivers/Class/HID.h * diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index feb6bf87a..205bb3d57 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB Audio Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Audio.h. + */ + /** \ingroup Group_USBClassCDC * @defgroup Group_USBClassCDCHost CDC Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h index d4ea7ac63..fd0227e6c 100644 --- a/LUFA/Drivers/USB/Class/Host/HID.h +++ b/LUFA/Drivers/USB/Class/Host/HID.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB HID Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/HID.h. + */ + /** \ingroup Group_USBClassHID * @defgroup Group_USBClassHIDHost HID Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Host/HIDParser.h b/LUFA/Drivers/USB/Class/Host/HIDParser.h index 6b6549b51..377a8217c 100644 --- a/LUFA/Drivers/USB/Class/Host/HIDParser.h +++ b/LUFA/Drivers/USB/Class/Host/HIDParser.h @@ -29,10 +29,11 @@ */ /** \file + * \brief USB Human Interface Device (HID) Class report descriptor parser. * - * USB Human Interface Device (HID) Class report descriptor processing routines. This file allows for the easy - * parsing of the complex HID report descriptor, which describes the data that the device transmits to the host. - * + * This file allows for the easy parsing of the complex HID report descriptor, which describes the data that + * the device transmits to the host. It also provides an easy API for extracting and processing the data + * elements inside a HID report sent from an attached HID device. */ /** \ingroup Group_USB diff --git a/LUFA/Drivers/USB/Class/Host/HIDReportData.h b/LUFA/Drivers/USB/Class/Host/HIDReportData.h index d3af672c3..197e62b03 100644 --- a/LUFA/Drivers/USB/Class/Host/HIDReportData.h +++ b/LUFA/Drivers/USB/Class/Host/HIDReportData.h @@ -29,9 +29,9 @@ */ /** \file + * \brief Constants for HID report item attributes. * - * Constants for HID report item attributes. Refer to the HID specification for details on each - * flag's meaning when applied to an IN, OUT or FEATURE item. + * Refer to the HID specification for details on each flag's meaning when applied to an IN, OUT or FEATURE item. */ /** \ingroup Group_HIDParser diff --git a/LUFA/Drivers/USB/Class/Host/MIDI.h b/LUFA/Drivers/USB/Class/Host/MIDI.h index 84779a0e8..e0ab9775b 100644 --- a/LUFA/Drivers/USB/Class/Host/MIDI.h +++ b/LUFA/Drivers/USB/Class/Host/MIDI.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB MIDI Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/MIDI.h. + */ + /** \ingroup Group_USBClassMIDI * @defgroup Group_USBClassMIDIHost MIDI Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h index 502e9021d..8868c9515 100644 --- a/LUFA/Drivers/USB/Class/Host/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB Mass Storage Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h. + */ + /** \ingroup Group_USBClassMS * @defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Host/Printer.h b/LUFA/Drivers/USB/Class/Host/Printer.h index 25b0beb7e..dc45780c2 100644 --- a/LUFA/Drivers/USB/Class/Host/Printer.h +++ b/LUFA/Drivers/USB/Class/Host/Printer.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB Printer Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/Printer.h. + */ + /** \ingroup Group_USBClassPrinter * @defgroup Group_USBClassPrinterHost Printer Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h index f42ed439c..5641620b7 100644 --- a/LUFA/Drivers/USB/Class/Host/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB RNDIS Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/RNDIS.h. + */ + /** \ingroup Group_USBClassRNDIS * @defgroup Group_USBClassRNDISHost RNDIS Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.c b/LUFA/Drivers/USB/Class/Host/StillImage.c index d116ceb74..50be7d6d2 100644 --- a/LUFA/Drivers/USB/Class/Host/StillImage.c +++ b/LUFA/Drivers/USB/Class/Host/StillImage.c @@ -151,7 +151,8 @@ uint8_t SImage_Host_SendBlockHeader(USB_ClassInfo_SI_Host_t* const SIInterfaceIn if ((USB_HostState != HOST_STATE_Configured) || !(SIInterfaceInfo->State.IsActive)) return PIPE_RWSTREAM_DeviceDisconnected; - PIMAHeader->TransactionID = SIInterfaceInfo->State.TransactionID++; + if (SIInterfaceInfo->State.IsSessionOpen) + PIMAHeader->TransactionID = SIInterfaceInfo->State.TransactionID++; Pipe_SelectPipe(SIInterfaceInfo->Config.DataOUTPipeNumber); Pipe_Unfreeze(); diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h index a2101262e..8a3714498 100644 --- a/LUFA/Drivers/USB/Class/Host/StillImage.h +++ b/LUFA/Drivers/USB/Class/Host/StillImage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB Still Image Class driver. + * + * \note This file should not be included directly. It is automatically included as needed by the class driver + * dispatch header located in LUFA/Drivers/USB/Class/StillImage.h. + */ + /** \ingroup Group_USBClassSI * @defgroup Group_USBClassStillImageHost Still Image Class Host Mode Driver * diff --git a/LUFA/Drivers/USB/Class/MIDI.h b/LUFA/Drivers/USB/Class/MIDI.h index 41f2916d3..b77ca543e 100644 --- a/LUFA/Drivers/USB/Class/MIDI.h +++ b/LUFA/Drivers/USB/Class/MIDI.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Master include file for the library USB MIDI Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers * @defgroup Group_USBClassMIDI MIDI Class Driver - LUFA/Drivers/Class/MIDI.h * diff --git a/LUFA/Drivers/USB/Class/MassStorage.h b/LUFA/Drivers/USB/Class/MassStorage.h index ccc48f35b..8f185d811 100644 --- a/LUFA/Drivers/USB/Class/MassStorage.h +++ b/LUFA/Drivers/USB/Class/MassStorage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Master include file for the library USB Mass Storage Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers * @defgroup Group_USBClassMS Mass Storage Class Driver - LUFA/Drivers/Class/MassStorage.h * diff --git a/LUFA/Drivers/USB/Class/Printer.h b/LUFA/Drivers/USB/Class/Printer.h index 0de231d17..785bac625 100644 --- a/LUFA/Drivers/USB/Class/Printer.h +++ b/LUFA/Drivers/USB/Class/Printer.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Master include file for the library USB Printer Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers * @defgroup Group_USBClassPrinter Printer Class Driver - LUFA/Drivers/Class/Printer.h * diff --git a/LUFA/Drivers/USB/Class/RNDIS.h b/LUFA/Drivers/USB/Class/RNDIS.h index 8fd6d16c8..cc2b3c09b 100644 --- a/LUFA/Drivers/USB/Class/RNDIS.h +++ b/LUFA/Drivers/USB/Class/RNDIS.h @@ -28,8 +28,15 @@ this software. */ +/** \file + * \brief Master include file for the library USB RNDIS Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers - * @defgroup Group_USBClassRNDIS RNDIS Class Driver - LUFA/Drivers/Class/RNDIS.h + * @defgroup Group_USBClassRNDIS RNDIS (Networking) Class Driver - LUFA/Drivers/Class/RNDIS.h * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: diff --git a/LUFA/Drivers/USB/Class/StillImage.h b/LUFA/Drivers/USB/Class/StillImage.h index 1ba5ff77e..9852e75a9 100644 --- a/LUFA/Drivers/USB/Class/StillImage.h +++ b/LUFA/Drivers/USB/Class/StillImage.h @@ -28,6 +28,13 @@ this software. */ +/** \file + * \brief Master include file for the library USB Still Image Class driver. + * + * This file should be included in all user projects making use of this optional class driver, instead of + * including any headers in the USB/ClassDriver/Device, USB/ClassDriver/Host or USB/ClassDriver/Common subdirectories. + */ + /** \ingroup Group_USBClassDrivers * @defgroup Group_USBClassSI Still Image Class Driver - LUFA/Drivers/Class/StillImage.h * -- cgit v1.2.3