X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/0557676013f41487701a8951d3dbb4aee3117882..eed7d4df6ae3da8616ec294d303ceea26078c707:/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 009018437..92751241b 100644 --- a/LUFA/Drivers/USB/Class/Device/HID.h +++ b/LUFA/Drivers/USB/Class/Device/HID.h @@ -31,6 +31,8 @@ /** \file * \brief Device mode driver for the library USB HID Class driver. * + * Device mode driver for the library USB HID Class driver. + * * \note This file should not be included directly. It is automatically included as needed by the class driver * dispatch header located in LUFA/Drivers/USB/Class/HID.h. */ @@ -69,7 +71,9 @@ /* Public Interface - May be used in end-application: */ /* Type Defines: */ - /** Class state structure. An instance of this structure should be made for each HID interface + /** \brief HID Class Device Mode Configuration and State Structure. + * + * Class state structure. An instance of this structure should be made for each HID interface * within the user application, and passed to each of the HID class driver functions as the * HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information. * @@ -102,7 +106,8 @@ uint8_t PrevReportINBufferSize; /**< Size in bytes of the given input report buffer. This is used to create a * second buffer of the same size within the driver so that subsequent reports * can be compared. If the user app is to determine when reports are to be sent - * exclusively (i.e. \ref PrevReportINBuffer is NULL) this value is ignored. + * exclusively (i.e. \ref PrevReportINBuffer is NULL) this value must still be + * set to the size of the largest report the device can issue to the host. */ } Config; /**< Config data for the USB class interface within the device. All elements in this section * must be set or the interface will fail to enumerate and operate correctly.