X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/d49cc0f7830319e701294e19937fae4de26ae8e2..d03d6513d0d24cf63225c8d3dfa07675d9107f40:/LUFA/Drivers/USB/Class/Host/HID.h diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h index d4ea7ac63..9c0400640 100644 --- a/LUFA/Drivers/USB/Class/Host/HID.h +++ b/LUFA/Drivers/USB/Class/Host/HID.h @@ -28,6 +28,15 @@ this software. */ +/** \file + * \brief Host mode driver for the library USB HID Class driver. + * + * Host 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. + */ + /** \ingroup Group_USBClassHID * @defgroup Group_USBClassHIDHost HID Class Host Mode Driver * @@ -66,7 +75,9 @@ #define HID_ERROR_LOGICAL 0x80 /* Type Defines: */ - /** Class state structure. An instance of this structure should be made within the user application, + /** \brief HID Class Host Mode Configuration and State Structure. + * + * Class state structure. An instance of this structure should be made 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. */ @@ -158,6 +169,7 @@ * * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail. + * \n\n * * \note The destination buffer should be large enough to accommodate the largest report that the attached device * can generate. @@ -175,6 +187,7 @@ * * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail. + * \n\n * * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable. * @@ -193,6 +206,7 @@ * * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the * call will fail. + * \n\n * * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, the ReportID parameter is removed * from the parameter list of this function. @@ -245,6 +259,7 @@ * * \note Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID * Report Parser this function references must be implemented in the user code. + * \n\n * * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable. *