Add support for Mouse Scrollwheel to the MouseHostWithParser demos.

[pub/lufa.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 dee892d..545b38d 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -74,12 +74,19 @@
                                        uint8_t  ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */\r
                                        uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */                                  \r
                                        \r
-                                       void*    PrevReportINBuffer; /** Pointer to a buffer where the previously created HID input report can be\r
+                                       void*    PrevReportINBuffer; /**< Pointer to a buffer where the previously created HID input report can be\r
                                                                      *  stored by the driver, for comparison purposes to detect report changes that\r
                                                                      *  must be sent immediately to the host. This should point to a buffer big enough\r
-                                                                     *  to hold the largest HID input report sent from the HID interface.\r
+                                                                     *  to hold the largest HID input report sent from the HID interface. If this is set\r
+                                                                                                 *  to NULL, it is up to the user to force transfers when needed in the \r
+                                                                                                 *  \ref CALLBACK_HID_Device_CreateHIDReport() callback function.\r
+                                                                                                 *\r
+                                                                                                 *  \note Due to the single buffer, the internal driver can only correctly compare\r
+                                                                                                 *        subsequent reports with identical report IDs. In multiple report devices,\r
+                                                                                                 *        this buffer should be set to NULL and the decision to send reports made\r
+                                                                                                 *        by the user application instead.\r
                                                                      */\r
-                                       uint8_t  PrevReportINBufferSize; /** Size in bytes of the given input report buffer. This is used to create a\r
+                                       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.\r
                                                                          */\r
@@ -89,9 +96,9 @@
                                struct\r
                                {\r
                                        bool     UsingReportProtocol; /**< Indicates if the HID interface is set to Boot or Report protocol mode */\r
-                                       uint16_t IdleCount; /**< Report idle period, in mS, set by the host */\r
-                                       uint16_t IdleMSRemaining; /**< Total number of mS remaining before the idle period elapsed - this should be\r
-                                                                                          *   decremented by the user application if non-zero each millisecond */      \r
+                                       uint16_t IdleCount; /**< Report idle period, in milliseconds, set by the host */\r
+                                       uint16_t IdleMSRemaining; /**< Total number of milliseconds remaining before the idle period elapsed - this \r
+                                                                                          *   should be decremented by the user application if non-zero each millisecond */    \r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
                                          *   are reset to their defaults when the interface is enumerated.\r
                                          */\r