aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/USB/Class/CDC.h
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2010-03-29 07:49:58 +0000
committerDean Camera <dean@fourwalledcubicle.com>2010-03-29 07:49:58 +0000
commit0557676013f41487701a8951d3dbb4aee3117882 (patch)
treed0c369cd182543f6a2344cb16bafb9be2d985665 /LUFA/Drivers/USB/Class/CDC.h
parentec19436d5456a095f652939c8163a9af2657f391 (diff)
downloadlufa-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/CDC.h')
-rw-r--r--LUFA/Drivers/USB/Class/CDC.h9
1 files changed, 8 insertions, 1 deletions
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: