diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2010-03-29 07:49:58 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2010-03-29 07:49:58 +0000 |
| commit | 0557676013f41487701a8951d3dbb4aee3117882 (patch) | |
| tree | d0c369cd182543f6a2344cb16bafb9be2d985665 /LUFA/Drivers/USB/Class/Common | |
| parent | ec19436d5456a095f652939c8163a9af2657f391 (diff) | |
| download | lufa-0557676013f41487701a8951d3dbb4aee3117882.tar.gz lufa-0557676013f41487701a8951d3dbb4aee3117882.tar.bz2 lufa-0557676013f41487701a8951d3dbb4aee3117882.zip | |
Add file-level brief documentation.
Remove accidentally duplicated model-specific peripheral driver files.
Diffstat (limited to 'LUFA/Drivers/USB/Class/Common')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/Audio.h | 7 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/CDC.h | 7 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/HID.h | 7 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/MIDI.h | 7 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/MassStorage.h | 7 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/Printer.h | 7 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/RNDIS.h | 7 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/RNDISConstants.h | 7 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Class/Common/StillImage.h | 7 |
9 files changed, 63 insertions, 0 deletions
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 @@ -29,6 +29,13 @@ */
/** \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
* constants, please refer to the Microsoft RNDIS specification.
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
*
|