diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2009-11-03 02:06:13 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2009-11-03 02:06:13 +0000 |
| commit | 870591983c80053d05175cfe54bab603a8a945d9 (patch) | |
| tree | d60678165a2343f126e622ae8813ffc65b0e17ac /LUFA/Drivers/USB/Class/Device/HID.h | |
| parent | de8c9445d478dc31dab7e042c9c2943d0758bbb3 (diff) | |
| download | lufa-870591983c80053d05175cfe54bab603a8a945d9.tar.gz lufa-870591983c80053d05175cfe54bab603a8a945d9.tar.bz2 lufa-870591983c80053d05175cfe54bab603a8a945d9.zip | |
Add const attribute to class driver APIs.
Add new manual pages detailing the advantages of LUFA over the official Atmel USB AVR stack, and reasons why LUFA should be used over a built-from-scratch USB stack.
Diffstat (limited to 'LUFA/Drivers/USB/Class/Device/HID.h')
| -rw-r--r-- | LUFA/Drivers/USB/Class/Device/HID.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h index 4865a1243..545b38d14 100644 --- a/LUFA/Drivers/USB/Class/Device/HID.h +++ b/LUFA/Drivers/USB/Class/Device/HID.h @@ -74,7 +74,7 @@ uint8_t ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */
uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */
- void* PrevReportINBuffer; /** Pointer to a buffer where the previously created HID input report can be
+ void* PrevReportINBuffer; /**< Pointer to a buffer where the previously created HID input report can be
* 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
@@ -86,7 +86,7 @@ * this buffer should be set to 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
+ 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.
*/
@@ -96,9 +96,9 @@ struct
{
bool UsingReportProtocol; /**< Indicates if the HID interface is set to Boot or Report protocol mode */
- uint16_t IdleCount; /**< Report idle period, in mS, set by the host */
- uint16_t IdleMSRemaining; /**< Total number of mS remaining before the idle period elapsed - this should be
- * decremented by the user application if non-zero each millisecond */
+ uint16_t IdleCount; /**< Report idle period, in milliseconds, set by the host */
+ uint16_t IdleMSRemaining; /**< Total number of milliseconds remaining before the idle period elapsed - this
+ * should be decremented by the user application if non-zero each millisecond */
} State; /**< State data for the USB class interface within the device. All elements in this section
* are reset to their defaults when the interface is enumerated.
*/
|