Added new EVENT_USB_Device_StartOfFrame() event, controlled by the new USB_Device_Ena...

[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 0c141e6..d995c09 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -119,7 +119,9 @@
                        void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
                        \r
                        /** Indicates that a millisecond of idle time has elapsed on the given HID interface, and the interface's idle count should be\r
                        void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);\r
                        \r
                        /** Indicates that a millisecond of idle time has elapsed on the given HID interface, and the interface's idle count should be\r

-                        *  decremented. This should be called once per millisecond so that hardware key-repeats function correctly.\r
+                        *  decremented. This should be called once per millisecond so that hardware key-repeats function correctly. It is recommended\r
+                        *  that this be called by the \ref EVENT_USB_Device_StartOfFrame() event, once SOF events have been enabled via\r
+                        *  \ref USB_Device_EnableSOFEvents();.\r

                         *\r
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
                         */\r
                         *\r
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
                         */\r