Merge pull request #46 from NicoHood/patch-1

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

diff --git a/LUFA/Drivers/USB/Class/Device/HIDClassDevice.h b/LUFA/Drivers/USB/Class/Device/HIDClassDevice.h
index a9de5a7..4a9b4ae 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HIDClassDevice.h
+++ b/LUFA/Drivers/USB/Class/Device/HIDClassDevice.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2012.
+     Copyright (C) Dean Camera, 2015.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2015  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -40,11 +40,11 @@
 /** \ingroup Group_USBClassHID
  *  \defgroup Group_USBClassHIDDevice HID Class Device Mode Driver
  *
 /** \ingroup Group_USBClassHID
  *  \defgroup Group_USBClassHIDDevice HID Class Device Mode Driver
  *

- *  \section Sec_Dependencies Module Source Dependencies
+ *  \section Sec_USBClassHIDDevice_Dependencies Module Source Dependencies

  *  The following files must be built with any user project that uses this module:
  *    - LUFA/Drivers/USB/Class/Device/HIDClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  *
  *  The following files must be built with any user project that uses this module:
  *    - LUFA/Drivers/USB/Class/Device/HIDClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  *

- *  \section Sec_ModDescription Module Description
+ *  \section Sec_USBClassHIDDevice_ModDescription Module Description

  *  Device Mode USB Class driver framework interface, for the HID USB Class driver.
  *
  *  @{
  *  Device Mode USB Class driver framework interface, for the HID USB Class driver.
  *
  *  @{


@@ -91,13 +91,13 @@
                                                                      *  stored by the driver, for comparison purposes to detect report changes that
                                                                      *  must be sent immediately to the host. This should point to a buffer big enough
                                                                      *  to hold the largest HID input report sent from the HID interface. If this is set
                                                                      *  stored by the driver, for comparison purposes to detect report changes that
                                                                      *  must be sent immediately to the host. This should point to a buffer big enough
                                                                      *  to hold the largest HID input report sent from the HID interface. If this is set

-                                                                                                 *  to \c NULL, it is up to the user to force transfers when needed in the
-                                                                                                 *  \ref CALLBACK_HID_Device_CreateHIDReport() callback function.
-                                                                                                 *
-                                                                                                 *  \note Due to the single buffer, the internal driver can only correctly compare
-                                                                                                 *        subsequent reports with identical report IDs. In multiple report devices,
-                                                                                                 *        this buffer should be set to \c NULL and the decision to send reports made
-                                                                                                 *        by the user application instead.
+                                                                     *  to \c NULL, it is up to the user to force transfers when needed in the
+                                                                     *  \ref CALLBACK_HID_Device_CreateHIDReport() callback function.
+                                                                     *
+                                                                     *  \note Due to the single buffer, the internal driver can only correctly compare
+                                                                     *        subsequent reports with identical report IDs. In multiple report devices,
+                                                                     *        this buffer should be set to \c NULL and the decision to send reports made
+                                                                     *        by the user application instead.

                                                                      */
                                        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
                                                                      */
                                        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