Minor documentation cleanups.

This commit is contained in:
Dean Camera 2010-06-03 15:32:45 +00:00
parent 9293de2491
commit fc92f9969c
109 changed files with 473 additions and 434 deletions

View file

@ -42,10 +42,10 @@
#include "KeyboardHost.h"
/* Macros: */
/** Interface Class value for the Human Interface Device class */
/** Interface Class value for the Human Interface Device class. */
#define KEYBOARD_CLASS 0x03
/** Interface Protocol value for a Boot Protocol Keyboard compliant device */
/** Interface Protocol value for a Boot Protocol Keyboard compliant device. */
#define KEYBOARD_PROTOCOL 0x01
/* Enums: */

View file

@ -53,10 +53,10 @@
#include "ConfigDescriptor.h"
/* Macros: */
/** Pipe number for the keyboard data IN pipe */
/** Pipe number for the keyboard data IN pipe. */
#define KEYBOARD_DATAPIPE 1
/** HID Class Specific request to set the report protocol mode */
/** HID Class Specific request to set the report protocol mode. */
#define REQ_SetProtocol 0x0B
/** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
@ -72,7 +72,7 @@
#define LEDMASK_USB_ERROR (LEDS_LED1 | LEDS_LED3)
/* Type Defines: */
/** Type define for a standard Boot Protocol Keyboard report */
/** Type define for a standard Boot Protocol Keyboard report. */
typedef struct
{
uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (such as Shift, Control, etc.) */