Minor documentation fixes.

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

diff --git a/Demos/Device/ClassDriver/Keyboard/Descriptors.h b/Demos/Device/ClassDriver/Keyboard/Descriptors.h
index 7ea7f47..2e91482 100644 (file)
--- a/Demos/Device/ClassDriver/Keyboard/Descriptors.h
+++ b/Demos/Device/ClassDriver/Keyboard/Descriptors.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library

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

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
-         
-  Permission to use, copy, modify, distribute, and sell this 
+  Copyright 2011  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
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -40,7 +40,6 @@
                #include <avr/pgmspace.h>
 
                #include <LUFA/Drivers/USB/USB.h>
                #include <avr/pgmspace.h>
 
                #include <LUFA/Drivers/USB/USB.h>

-               #include <LUFA/Drivers/USB/Class/HID.h>

 
        /* Type Defines: */
                /** Type define for the device configuration descriptor structure. This must be defined in the
 
        /* Type Defines: */
                /** Type define for the device configuration descriptor structure. This must be defined in the


@@ -50,20 +49,25 @@
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t Config;
                typedef struct
                {
                        USB_Descriptor_Configuration_Header_t Config;

+
+                       // Keyboard HID Interface

                        USB_Descriptor_Interface_t            HID_Interface;
                        USB_Descriptor_Interface_t            HID_Interface;

-                       USB_HID_Descriptor_t                  HID_KeyboardHID;
+                       USB_HID_Descriptor_HID_t              HID_KeyboardHID;

                USB_Descriptor_Endpoint_t             HID_ReportINEndpoint;
                } USB_Descriptor_Configuration_t;
                USB_Descriptor_Endpoint_t             HID_ReportINEndpoint;
                } USB_Descriptor_Configuration_t;

-                                       
+

        /* Macros: */
                /** Endpoint number of the Keyboard HID reporting IN endpoint. */
                #define KEYBOARD_EPNUM               1
        /* Macros: */
                /** Endpoint number of the Keyboard HID reporting IN endpoint. */
                #define KEYBOARD_EPNUM               1

-               
-               /** Size in bytes of the Keyboard HID reporting IN and OUT endpoints. */                
+
+               /** Size in bytes of the Keyboard HID reporting IN endpoint. */

                #define KEYBOARD_EPSIZE              8
 
        /* Function Prototypes: */
                #define KEYBOARD_EPSIZE              8
 
        /* Function Prototypes: */

-               uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue, const uint8_t wIndex, void** const DescriptorAddress)
-                                                                                       ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);
+               uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
+                                                   const uint8_t wIndex,
+                                                   const void** const DescriptorAddress)
+                                                   ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(3);

 
 #endif
 
 #endif

+