Fixed CDC and USBtoSerial demos freezing where buffers were full while still transmit...

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

diff --git a/LUFA/Drivers/USB/HighLevel/USBTask.h b/LUFA/Drivers/USB/HighLevel/USBTask.h
index 5bbd4f9..bcf117d 100644 (file)
--- a/LUFA/Drivers/USB/HighLevel/USBTask.h
+++ b/LUFA/Drivers/USB/HighLevel/USBTask.h
@@ -46,7 +46,7 @@
                \r
                #include "../../../Scheduler/Scheduler.h"\r
                #include "../LowLevel/LowLevel.h"\r
-               #include "../LowLevel/USBMode.h"\r
+               #include "USBMode.h"\r
                #include "Events.h"\r
                #include "StdDescriptors.h"\r
 \r
@@ -73,14 +73,18 @@
                         *        needs to be determined, VBUS should be routed to an external pin, and the auto-detect behaviour turned off by\r
                         *        passing the NO_LIMITED_CONTROLLER_CONNECT token to the compiler via the -D switch at compile time. The connection\r
                         *        and disconnection events may be manually fired by RAISE_EVENT(), and the USB_IsConnected global changed manually.\r
+                        *\r
+                        *  \ingroup Group_USBManagement\r
                         */\r
                        extern volatile bool USB_IsConnected;\r
 \r
-                       /** Indicates if the USB interface is currently initialized but not neccesarily connected to a host\r
+                       /** Indicates if the USB interface is currently initialized but not necessarily connected to a host\r
                         *  or device (i.e. if USB_Init() has been run). If this is false, all other library globals are invalid.\r
                         *\r
                         *  \note This variable should be treated as read-only in the user application, and never manually\r
                         *        changed in value.\r
+                        *\r
+                        *  \ingroup Group_USBManagement\r
                         */\r
                        extern volatile bool USB_IsInitialized;\r
 \r
@@ -94,6 +98,8 @@
                         *\r
                         *  \note This variable should be treated as read-only in the user application, and never manually\r
                         *        changed in value.\r
+                        *\r
+                        *  \ingroup Group_Device\r
                         */\r
                        extern volatile bool USB_IsSuspended;\r
                        #endif\r
@@ -107,6 +113,8 @@
                         *  by the library.\r
                         *\r
                         *  \note This global is only present if the user application can be a USB host.\r
+                        *\r
+                        *  \ingroup Group_Host\r
                         */\r
                        extern volatile uint8_t USB_HostState;\r
                        #endif\r
@@ -166,13 +174,15 @@
                         *  The USB task must be serviced within 50mS in all modes, when needed. The task may be serviced \r
                         *  at all times, or (for minimum CPU consumption):\r
                         *\r
-                        *    - In device mode, it may be disabled at startup, enabled on the firing of the USB_Connect event\r
+                        *    - In device mode, it may be disabled at start-up, enabled on the firing of the USB_Connect event\r
                         *    and disabled again on the firing of the USB_Disconnect event.\r
                         *\r
-                        *    - In host mode, it may be disabled at startup, enabled on the firing of the USB_DeviceAttached\r
+                        *    - In host mode, it may be disabled at start-up, enabled on the firing of the USB_DeviceAttached\r
                         *    event and disabled again on the firing of the USB_DeviceUnattached event.\r
                         *\r
                         *  \see Events.h for more information on the USB events.\r
+                        *\r
+                        *  \ingroup Group_USBManagement\r
                         */\r
                        TASK(USB_USBTask);\r
 \r