Add master device Host demo makefile.

[pub/USBasp.git] / LUFA / Drivers / USB / USB.h

diff --git a/LUFA/Drivers/USB/USB.h b/LUFA/Drivers/USB/USB.h
index 499c59b..d0837a8 100644 (file)
--- a/LUFA/Drivers/USB/USB.h
+++ b/LUFA/Drivers/USB/USB.h
@@ -33,11 +33,54 @@
  *  Master include file for the library USB functionality. This file should be included in all user projects making\r
  *  use of the USB portions of the library, instead of including any headers in the USB/LowLevel or USB/HighLevel\r
  *  directories.\r
+ */\r
+\r
+/** @defgroup Group_USB USB - LUFA/Drivers/USB/USB.h\r
+ *\r
+ *  \section Sec_Dependencies Module Source Dependencies\r
+ *  The following files must be built with any user project that uses this module:\r
+ *    - LUFA/Drivers/USB/LowLevel/DevChapter9.c\r
+ *    - LUFA/Drivers/USB/LowLevel/Endpoint.c\r
+ *    - LUFA/Drivers/USB/LowLevel/Host.c\r
+ *    - LUFA/Drivers/USB/LowLevel/HostChapter9.c\r
+ *    - LUFA/Drivers/USB/LowLevel/LowLevel.c\r
+ *    - LUFA/Drivers/USB/LowLevel/Pipe.c\r
+ *    - LUFA/Drivers/USB/HighLevel/Events.c\r
+ *    - LUFA/Drivers/USB/HighLevel/USBInterrupt.c\r
+ *    - LUFA/Drivers/USB/HighLevel/USBTask.c\r
+ *    - LUFA/Drivers/USB/HighLevel/ConfigDescriptor.c\r
  *\r
- *  Class specific utility files in USB/Class/ must still be included manually, as they are not normally part of\r
- *  the USB library unless desired by the library user.\r
+ *  \section Module Description\r
+ *  Functions, macros, variables, enums and types related to the management of USB communications.\r
  */\r
 \r
+/** \ingroup Group_USB\r
+ *  @defgroup Group_USBClassDrivers USB Class Drivers\r
+ *\r
+ *  Drivers for both host and device mode of the standard USB classes, for rapid application development.\r
+ *  Class drivers give a framework which sits on top of the low level library API, allowing for standard\r
+ *  USB classes to be implemented in a project with minimal user code. These drivers can be used in\r
+ *  conjunction with the library low level APIs to implement interfaces both via the class drivers and via\r
+ *  the standard library APIs.\r
+ *\r
+ *  Multiple device mode class drivers can be used within a project, including multiple instances of the\r
+ *  same class driver.\r
+ */\r
+ \r
+/** \ingroup Group_USBClassDrivers\r
+ *  @defgroup Group_USBDeviceClassDrivers Device Class Drivers\r
+ *\r
+ *  Device mode drivers for the standard USB classes. These drivers all implement one of the standard USB\r
+ *  classes, allowing for the class to be easily implemented in a user project.\r
+ */\r
+ \r
+/** \ingroup Group_USBClassDrivers\r
+ *  @defgroup Group_USBHostClassDrivers Host Class Drivers\r
+ *\r
+ *  Host mode drivers for the standard USB classes. These drivers all implement one of the standard USB\r
+ *  classes, allowing for the class to be easily implemented in a user project.\r
+ */\r
+ \r
 #ifndef __USB_H__\r
 #define __USB_H__\r
 \r
@@ -55,7 +98,7 @@
                #endif\r
                \r
        /* Includes: */\r
-               #include "Highlevel/USBMode.h"\r
+               #include "HighLevel/USBMode.h"\r
                #include "HighLevel/USBTask.h"\r
                #include "HighLevel/USBInterrupt.h"\r
                #include "HighLevel/Events.h"\r
@@ -79,5 +122,7 @@
                        #include "LowLevel/OTG.h"\r
                #endif\r
                \r
+               #include "HighLevel/ConfigDescriptor.h"\r
+               \r
 #endif\r
 \r