Add briefs for the library core structures.

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

diff --git a/LUFA/Drivers/USB/Class/Common/HID.h b/LUFA/Drivers/USB/Class/Common/HID.h
index cf457cb..0c908c5 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/HID.h
+++ b/LUFA/Drivers/USB/Class/Common/HID.h
@@ -31,6 +31,8 @@
 /** \file\r
  *  \brief Common definitions and declarations for the library USB HID Class driver.\r
  *\r
 /** \file\r
  *  \brief Common definitions and declarations for the library USB HID Class driver.\r
  *\r

+ *  Common definitions and declarations 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


@@ -143,7 +145,9 @@
                        REPORT_ITEM_TYPE_Feature              = 2, /**< Indicates that the item is a FEATURE report type. */\r
                };\r
 \r
                        REPORT_ITEM_TYPE_Feature              = 2, /**< Indicates that the item is a FEATURE report type. */\r
                };\r
 \r

-               /** Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID\r
+               /** \brief HID Class Specific HID Descriptor.\r
+                *\r
+                *  Type define for the HID class specific HID descriptor, to describe the HID device's specifications. Refer to the HID\r

                 *  specification for details on the structure elements.\r
                 */\r
                typedef struct\r
                 *  specification for details on the structure elements.\r
                 */\r
                typedef struct\r


@@ -159,7 +163,10 @@
                        uint16_t                 HIDReportLength;\r
                } USB_HID_Descriptor_t;\r
 \r
                        uint16_t                 HIDReportLength;\r
                } USB_HID_Descriptor_t;\r
 \r

-               /** Type define for a standard Boot Protocol Mouse report */\r
+               /** \brief Standard HID Boot Protocol Mouse Report.\r
+                *\r
+                *  Type define for a standard Boot Protocol Mouse report\r
+                */\r

                typedef struct\r
                {\r
                        uint8_t Button; /**< Button mask for currently pressed buttons in the mouse */\r
                typedef struct\r
                {\r
                        uint8_t Button; /**< Button mask for currently pressed buttons in the mouse */\r


@@ -167,7 +174,10 @@
                        int8_t  Y; /**< Current delta Y movement on the mouse */\r
                } USB_MouseReport_Data_t;\r
                \r
                        int8_t  Y; /**< Current delta Y movement on the mouse */\r
                } USB_MouseReport_Data_t;\r
                \r

-               /** Type define for a standard Boot Protocol Keyboard report */\r
+               /** \brief Standard HID Boot Protocol Keyboard Report.\r
+                *\r
+                *  Type define for a standard Boot Protocol Keyboard report\r
+                */\r

                typedef struct\r
                {\r
                        uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (a combination of\r
                typedef struct\r
                {\r
                        uint8_t Modifier; /**< Keyboard modifier byte, indicating pressed modifier keys (a combination of\r