Add some more documentation to the half-completed Bluetooth Host demo, fix the OpenCh...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / HID.h

diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h
index d4ea7ac..29c390a 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -28,6 +28,15 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief Host mode driver for the library USB HID Class driver.\r
+ *\r
+ *  Host mode driver for the library USB HID Class driver.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ *        dispatch header located in LUFA/Drivers/USB/Class/HID.h.\r
+ */\r
+\r

 /** \ingroup Group_USBClassHID\r
  *  @defgroup Group_USBClassHIDHost HID Class Host Mode Driver\r
  *\r
 /** \ingroup Group_USBClassHID\r
  *  @defgroup Group_USBClassHIDHost HID Class Host Mode Driver\r
  *\r


@@ -66,7 +75,9 @@
                        #define HID_ERROR_LOGICAL              0x80\r
        \r
                /* Type Defines: */\r
                        #define HID_ERROR_LOGICAL              0x80\r
        \r
                /* Type Defines: */\r

-                       /** Class state structure. An instance of this structure should be made within the user application,\r
+                       /** \brief HID Class Host Mode Configuration and State Structure.\r
+                        *\r
+                        *  Class state structure. An instance of this structure should be made within the user application,\r

                         *  and passed to each of the HID class driver functions as the HIDInterfaceInfo parameter. This\r
                         *  stores each HID interface's configuration and state information.\r
                         */\r
                         *  and passed to each of the HID class driver functions as the HIDInterfaceInfo parameter. This\r
                         *  stores each HID interface's configuration and state information.\r
                         */\r