X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/03130342451003093e654edc5b031718d544e9ba..def0e0ff1b10a1c101885e83624a418e24be8648:/LUFA/Drivers/USB/Class/Host/HIDParser.h?ds=sidebyside

diff --git a/LUFA/Drivers/USB/Class/Host/HIDParser.h b/LUFA/Drivers/USB/Class/Host/HIDParser.h
index 6f4ff1d31..f772fed20 100644
--- a/LUFA/Drivers/USB/Class/Host/HIDParser.h
+++ b/LUFA/Drivers/USB/Class/Host/HIDParser.h
@@ -41,7 +41,7 @@
  *
  *  \section Sec_Dependencies Module Source Dependencies
  *  The following files must be built with any user project that uses this module:
- *    - LUFA/Drivers/USB/Class/Host/HIDParser.c
+ *    - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>
  *
  *  \section Module Description
  *  Functions, macros, variables, enums and types related to the parsing of HID class device report descriptors.
@@ -278,22 +278,25 @@
 			 *
 			 *  \return A value in the \ref HID_Parse_ErrorCodes_t enum.
 			 */
-			uint8_t USB_ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_ReportInfo_t* const ParserData)
-			                             ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
+			uint8_t USB_ProcessHIDReport(const uint8_t* ReportData,
+			                             uint16_t ReportSize,
+			                             HID_ReportInfo_t* const ParserData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(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 \ref HID_ReportItem_t structure.
 			 *
-			 *  When called, this copies the report item's Value element to it's PreviousValue element for easy
-			 *  checking to see if an item's value has changed before processing a report.
+			 *  When called on a report with an item that exists in that report, this copies the report item's Value 
+			 *  to it's PreviousValue element for easy checking to see if an item's value has changed before processing
+			 *  a report. If the given item does not exist in the report, the function does not modify the report item's
+			 *  data.
 			 *
 			 *  \param[in]     ReportData  Buffer containing an IN or FEATURE report from an attached device.
 			 *  \param[in,out] ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array.
 			 *
 			 *  \returns Boolean true if the item to retrieve was located in the given report, false otherwise.
 			 */
-			bool USB_GetHIDReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem)
-			                              ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
+			bool USB_GetHIDReportItemInfo(const uint8_t* ReportData,
+			                              HID_ReportItem_t* const ReportItem) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 
 			/** Retrieves the given report item's value out of the Value member of the report item's
 			 *  \ref HID_ReportItem_t structure and places it into the correct position in the HID report
@@ -308,9 +311,9 @@
 			 *  \param[out] ReportData  Buffer holding the current OUT or FEATURE report data.
 			 *  \param[in]  ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array.
 			 */
-			void USB_SetHIDReportItemInfo(uint8_t* ReportData, HID_ReportItem_t* const ReportItem)
-			                              ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
-										  
+			void USB_SetHIDReportItemInfo(uint8_t* ReportData,
+			                              HID_ReportItem_t* const ReportItem) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
+
 			/** Retrieves the size of a given HID report in bytes from it's Report ID.
 			 *
 			 *  \param[in] ParserData  Pointer to a \ref HID_ReportInfo_t instance containing the parser output.
@@ -320,7 +323,8 @@
 			 *
 			 *  \return Size of the report in bytes, or 0 if the report does not exist.
 			 */
-			uint16_t USB_GetHIDReportSize(HID_ReportInfo_t* const ParserData, const uint8_t ReportID,
+			uint16_t USB_GetHIDReportSize(HID_ReportInfo_t* const ParserData,
+			                              const uint8_t ReportID,
 			                              const uint8_t ReportType) ATTR_CONST ATTR_NON_NULL_PTR_ARG(1);
 
 			/** Callback routine for the HID Report Parser. This callback <b>must</b> be implemented by the user code when