Add start of a SDP service table, which will be linked to the Bluetooth SDP code.

[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 fd0227e..9c04006 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -31,6 +31,8 @@
 /** \file\r
  *  \brief Host mode driver for the library USB HID Class driver.\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
  *  \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


@@ -73,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


@@ -165,6 +169,7 @@
                         *  \r
                         *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
                         *        call will fail.\r
                         *  \r
                         *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
                         *        call will fail.\r

+                        *        \n\n\r

                         *\r
                         *  \note The destination buffer should be large enough to accommodate the largest report that the attached device\r
                         *        can generate.\r
                         *\r
                         *  \note The destination buffer should be large enough to accommodate the largest report that the attached device\r
                         *        can generate.\r


@@ -182,6 +187,7 @@
                         *\r
                         *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
                         *        call will fail.\r
                         *\r
                         *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
                         *        call will fail.\r

+                        *        \n\n\r

                         *\r
                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\r
                         *\r
                         *\r
                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\r
                         *\r


@@ -200,6 +206,7 @@
                         *\r
                         *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
                         *        call will fail.\r
                         *\r
                         *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the\r
                         *        call will fail.\r

+                        *        \n\n\r

                         *\r
                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, the ReportID parameter is removed\r
                         *        from the parameter list of this function.\r
                         *\r
                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, the ReportID parameter is removed\r
                         *        from the parameter list of this function.\r


@@ -252,6 +259,7 @@
                         *\r
                         *  \note Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID\r
                         *        Report Parser this function references <b>must</b> be implemented in the user code.\r
                         *\r
                         *  \note Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID\r
                         *        Report Parser this function references <b>must</b> be implemented in the user code.\r

+                        *        \n\n\r

                         *\r
                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\r
                         *\r
                         *\r
                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\r
                         *\r