Minor documentation cleanups.
This commit is contained in:
parent
9293de2491
commit
fc92f9969c
109 changed files with 473 additions and 434 deletions
|
@ -42,16 +42,16 @@
|
|||
#include "HIDReport.h"
|
||||
|
||||
/* Macros: */
|
||||
/** Interface Class value for the Human Interface Device class */
|
||||
/** Interface Class value for the Human Interface Device class. */
|
||||
#define MOUSE_CLASS 0x03
|
||||
|
||||
/** Interface Protocol value for a Boot Protocol Mouse compliant device */
|
||||
/** Interface Protocol value for a Boot Protocol Mouse compliant device. */
|
||||
#define MOUSE_PROTOCOL 0x02
|
||||
|
||||
/** Descriptor header type constant for a HID descriptor */
|
||||
/** Descriptor header type constant for a HID descriptor. */
|
||||
#define DTYPE_HID 0x21
|
||||
|
||||
/** Descriptor header type constant for a HID report descriptor */
|
||||
/** Descriptor header type constant for a HID report descriptor. */
|
||||
#define DTYPE_Report 0x22
|
||||
|
||||
/* Enums: */
|
||||
|
|
|
@ -43,22 +43,22 @@
|
|||
#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: */
|
||||
|
|
|
@ -54,7 +54,7 @@
|
|||
#include "HIDReport.h"
|
||||
|
||||
/* Macros: */
|
||||
/** Pipe number for the mouse report data pipe */
|
||||
/** Pipe number for the mouse report data pipe. */
|
||||
#define MOUSE_DATAPIPE 1
|
||||
|
||||
/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue