#include "MouseHostWithParser.h"
/* Macros: */
- /** HID Report Descriptor Usage for a Mouse */
+ /** HID Report Descriptor Usage for a Mouse. */
#define USAGE_MOUSE 0x02
- /** HID Report Descriptor Usage Page value for a toggle button */
+ /** HID Report Descriptor Usage Page value for a toggle button. */
#define USAGE_PAGE_BUTTON 0x09
- /** HID Report Descriptor Usage Page value for a Generic Desktop Control */
+ /** HID Report Descriptor Usage Page value for a Generic Desktop Control. */
#define USAGE_PAGE_GENERIC_DCTRL 0x01
- /** HID Report Descriptor Usage value for a X axis movement */
+ /** HID Report Descriptor Usage value for a X axis movement. */
#define USAGE_X 0x30
- /** HID Report Descriptor Usage value for a Y axis movement */
+ /** HID Report Descriptor Usage value for a Y axis movement. */
#define USAGE_Y 0x31
- /** HID Report Descriptor Usage value for a Scroll Wheel movement */
+ /** HID Report Descriptor Usage value for a Scroll Wheel movement. */
#define USAGE_SCROLL_WHEEL 0x38
/* Enums: */
- /** Enum for the possible return codes of the GetHIDReportData() function. */
+ /** Enum for the possible return codes of the \ref GetHIDReportData() function. */
enum MouseHostWithParser_GetHIDReportDataCodes_t
{
ParseSuccessful = 0, /**< HID report descriptor parsed successfully */