Minor documentation improvements.

[pub/USBasp.git] / Demos / Device / ClassDriver / KeyboardMouseMultiReport / Descriptors.h

diff --git a/Demos/Device/ClassDriver/KeyboardMouseMultiReport/Descriptors.h b/Demos/Device/ClassDriver/KeyboardMouseMultiReport/Descriptors.h
index 0a9d729..f579edf 100644 (file)
--- a/Demos/Device/ClassDriver/KeyboardMouseMultiReport/Descriptors.h
+++ b/Demos/Device/ClassDriver/KeyboardMouseMultiReport/Descriptors.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2012.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -49,6 +49,8 @@
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t Config;
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t Config;

+
+                       // Combined Keyboard/Mouse HID Interface

                        USB_Descriptor_Interface_t            HID_Interface;
                        USB_HID_Descriptor_HID_t              HID_HIDData;
                        USB_Descriptor_Endpoint_t             HID_ReportINEndpoint;
                        USB_Descriptor_Interface_t            HID_Interface;
                        USB_HID_Descriptor_HID_t              HID_HIDData;
                        USB_Descriptor_Endpoint_t             HID_ReportINEndpoint;


@@ -58,13 +60,15 @@
                /** Endpoint number of the HID reporting IN endpoint. */
                #define HID_IN_EPNUM              1
 
                /** Endpoint number of the HID reporting IN endpoint. */
                #define HID_IN_EPNUM              1
 

-               /** Size in bytes of each of the HID reporting IN. */
-               #define HID_EPSIZE                16
-               
+               /** Size in bytes of each of the HID reporting IN endpoint. */
+               #define HID_EPSIZE                8
+
+       /* Enums: */
+               /** Enum for the HID report IDs used in the device. */

                enum
                {
                enum
                {

-                       HID_REPORTID_MouseReport    = 0x01,
-                       HID_REPORTID_KeyboardReport = 0x02,
+                       HID_REPORTID_MouseReport    = 0x01, /**< Report ID for the Mouse report within the device. */
+                       HID_REPORTID_KeyboardReport = 0x02, /**< Report ID for the Keyboard report within the device. */

                } HID_Report_IDs;
 
        /* Function Prototypes: */
                } HID_Report_IDs;
 
        /* Function Prototypes: */