X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/6a10d6b465be27db090d760dc0fbe722c94e4344..6865a7bc09e31d3bbebb33eefb6475c8713351bd:/LUFA/Drivers/USB/Class/HIDParser.h

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