Added new ENDPOINT_*_BusSuspended error code to the Endpoint function, so that the...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Device / HID.h

diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h
index 15b428a..9275124 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
+/** \file\r
+ *  \brief Device mode driver for the library USB HID Class driver.\r
+ *\r
+ *  Device mode driver for the library USB HID Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/HID.h.\r
+ */\r
+\r
 /** \ingroup Group_USBClassHID\r
  *  @defgroup Group_USBClassHIDDevice HID Class Device Mode Driver\r
  *\r
@@ -62,7 +71,9 @@
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Type Defines: */\r
-                       /** Class state structure. An instance of this structure should be made for each HID interface\r
+                       /** \brief HID Class Device Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made for each HID interface\r
                         *  within the user application, and passed to each of the HID class driver functions as the\r
                         *  HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.\r
                         *\r
@@ -95,7 +106,8 @@
                                        uint8_t  PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a\r
                                                                          *  second buffer of the same size within the driver so that subsequent reports\r
                                                                          *  can be compared. If the user app is to determine when reports are to be sent\r
-                                                                         *  exclusively (i.e. \ref PrevReportINBuffer is NULL) this value is ignored.\r
+                                                                         *  exclusively (i.e. \ref PrevReportINBuffer is NULL) this value must still be\r
+                                                                                                         *  set to the size of the largest report the device can issue to the host.\r
                                                                          */\r
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r