X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/eb2e883fd35b5332a7425488105a7adb500ce3fe..01d5af3d6c17f052314c9e739a40b284ed645101:/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h diff --git a/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h b/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h index 95b3484fd..add6cf8c0 100644 --- a/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h +++ b/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2011. + Copyright (C) Dean Camera, 2012. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2012 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 @@ -91,7 +91,7 @@ /** Constant for a keyboard report modifier byte, indicating that the keyboard's right GUI key is currently pressed. */ #define HID_KEYBOARD_MODIFIER_RIGHTGUI (1 << 7) //@} - + /** \name Keyboard Standard Report LED Masks */ //@{ /** Constant for a keyboard output report LED byte, indicating that the host's NUM LOCK mode is currently set. */ @@ -108,7 +108,7 @@ //@} /** \name Keyboard Standard Report Key Scan-codes */ - //@{ + //@{ #define HID_KEYBOARD_SC_ERROR_ROLLOVER 0x01 #define HID_KEYBOARD_SC_POST_FAIL 0x02 #define HID_KEYBOARD_SC_ERROR_UNDEFINED 0x03 @@ -208,7 +208,7 @@ #define HID_KEYBOARD_SC_KEYPAD_9_AND_PAGE_UP 0x61 #define HID_KEYBOARD_SC_KEYPAD_0_AND_INSERT 0x62 #define HID_KEYBOARD_SC_KEYPAD_DOT_AND_DELETE 0x63 - #define HID_KEYBOARD_SC_NON_US_BACKSLASH_AND_PIPE 0x64 + #define HID_KEYBOARD_SC_NON_US_BACKSLASH_AND_PIPE 0x64 #define HID_KEYBOARD_SC_POWER 0x66 #define HID_KEYBOARD_SC_EQUAL_SIGN 0x67 #define HID_KEYBOARD_SC_F13 0x68 @@ -392,7 +392,7 @@ * \code * struct * { - * uint8_t Modifier; // Keyboard modifier byte indicating pressed modifier keys (HID_KEYBOARD_MODIFER_* masks) + * uint8_t Modifier; // Keyboard modifier byte indicating pressed modifier keys (\c HID_KEYBOARD_MODIFER_* masks) * uint8_t Reserved; // Reserved for OEM use, always set to 0. * uint8_t KeyCode[MaxKeys]; // Length determined by the number of keys that can be reported * } Keyboard_Report; @@ -456,7 +456,7 @@ * \param[in] MinPhysicalVal Minimum X/Y physical axis value, for movement resolution calculations (16-bit). * \param[in] MaxPhysicalVal Maximum X/Y physical axis value, for movement resolution calculations (16-bit). * \param[in] Buttons Total number of buttons in the device (8-bit). - * \param[in] AbsoluteCoords Boolean true to use absolute X/Y coordinates (e.g. touchscreen). + * \param[in] AbsoluteCoords Boolean \c true to use absolute X/Y coordinates (e.g. touchscreen). */ #define HID_DESCRIPTOR_MOUSE(MinAxisVal, MaxAxisVal, MinPhysicalVal, MaxPhysicalVal, Buttons, AbsoluteCoords) \ HID_RI_USAGE_PAGE(8, 0x01), \ @@ -491,12 +491,12 @@ /** \hideinitializer * A list of HID report item array elements that describe a typical Vendor Defined byte array HID report descriptor, * used for transporting arbitrary data between the USB host and device via HID reports. The resulting report should be - * a uint8_t byte array of the specified length in both Device to Host (IN) and Host to Device (OUT) directions. + * a \c uint8_t byte array of the specified length in both Device to Host (IN) and Host to Device (OUT) directions. * * \param[in] VendorPageNum Vendor Defined HID Usage Page index, ranging from 0x00 to 0xFF. * \param[in] CollectionUsage Vendor Usage for the encompassing report IN and OUT collection, ranging from 0x00 to 0xFF. * \param[in] DataINUsage Vendor Usage for the IN report data, ranging from 0x00 to 0xFF. - * \param[in] DataOUTUsage Vendor Usage for the OUT report data, ranging from 0x00 to 0xFF. + * \param[in] DataOUTUsage Vendor Usage for the OUT report data, ranging from 0x00 to 0xFF. * \param[in] NumBytes Length of the data IN and OUT reports. */ #define HID_DESCRIPTOR_VENDOR(VendorPageNum, CollectionUsage, DataINUsage, DataOUTUsage, NumBytes) \ @@ -517,7 +517,7 @@ HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE), \ HID_RI_END_COLLECTION(0) //@} - + /* Type Defines: */ /** Enum for possible Class, Subclass and Protocol values of device and interface descriptors relating to the HID * device class. @@ -543,7 +543,7 @@ * belongs to the Mouse HID boot protocol. */ }; - + /** Enum for the HID class specific control requests that can be issued by the USB bus host. */ enum HID_ClassRequests_t {