Applied STATIC_ENDPOINT_CONFIGURATION and FIXED_CONTROL_SIZE tokens to all Device...

[pub/lufa.git] / LUFA / Drivers / USB / Class / HIDParser.h

diff --git a/LUFA/Drivers/USB/Class/HIDParser.h b/LUFA/Drivers/USB/Class/HIDParser.h
index 314d080..f02f1fd 100644 (file)
--- a/LUFA/Drivers/USB/Class/HIDParser.h
+++ b/LUFA/Drivers/USB/Class/HIDParser.h
@@ -33,7 +33,14 @@
  *  USB Human Interface Device (HID) Class report descriptor processing routines. This file allows for the easy\r
  *  parsing of the complex HID report descriptor, which describes the data that the device transmits to the host.\r
  *\r
- *  The processed report is presented back to the user application as a flat structure containing each report\r
+ */\r
+ \r
+/** \ingroup Group_USB\r
+ *  @defgroup Group_HIDParser HID Report Parser\r
+ *\r
+ *  Functions, macros, variables, enums and types related to the parsing of HID class device report descriptors.\r
+ *\r
+ *  The processed HID report is presented back to the user application as a flat structure containing each report\r
  *  item's IN, OUT and FEATURE (if desired) items along with each item's attributes.\r
  *\r
  *  This library portion also allows for easy setting and retrieval of data from a HID report, including devices\r
@@ -43,6 +50,8 @@
  *  to save on memory. This can be overridden by defining the HID_ENABLE_FEATURE_PROCESSING or\r
  *  HID_INCLUDE_CONSTANT_DATA_ITEMS tokens in the user project makefile, passing them to the compiler via the -D\r
  *  switch.\r
+ *\r
+ *  @{\r
  */\r
 \r
 #ifndef __HIDPARSER_H__\r
@@ -206,8 +215,8 @@
                         *\r
                         *  \return A value in the HID_Parse_ErrorCodes_t enum\r
                         */\r
-                       uint8_t ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_ReportInfo_t* const ParserData)\r
-                                                ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                       uint8_t USB_ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_ReportInfo_t* const ParserData)\r
+                                                    ATTR_NON_NULL_PTR_ARG(1, 3);\r
 \r
                        /** Extracts the given report item's value out of the given HID report and places it into the Value\r
                         *  member of the report item's HID_ReportItem_t structure.\r
@@ -217,10 +226,10 @@
                         *\r
                         *  \returns Boolean true if the item to retrieve was located in the given report, false otherwise\r
                         */\r
-                       bool GetReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem)\r
-                                              ATTR_NON_NULL_PTR_ARG(1, 2);\r
+                       bool USB_GetHIDReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem)\r
+                                                     ATTR_NON_NULL_PTR_ARG(1, 2);\r
 \r
-                       /** Retreives the given report item's value out of the Value member of the report item's\r
+                       /** Retrieves the given report item's value out of the Value member of the report item's\r
                         *  HID_ReportItem_t structure and places it into the correct position in the HID report\r
                         *  buffer. The report buffer is assumed to have the appropriate bits cleared before calling\r
                         *  this function (i.e., the buffer should be explicitly cleared before report values are added).\r
@@ -230,8 +239,8 @@
                         *  \param ReportData  Buffer holding the current OUT report data\r
                         *  \param ReportItem  Pointer to the report item of interest in a HID_ReportInfo_t ReportItem array\r
                         */\r
-                       void SetReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)\r
-                                              ATTR_NON_NULL_PTR_ARG(1, 2);\r
+                       void USB_SetHIDReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)\r
+                                                     ATTR_NON_NULL_PTR_ARG(1, 2);\r
 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
@@ -250,3 +259,5 @@
                #endif\r
 \r
 #endif\r
+\r
+/** @} */\r