X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/3cbdcd36868693cfc1863231a1ec64507ce3d29f..cbbd3d746acef02a4afd562652a2ba71b24dfd6f:/LUFA/Drivers/USB/Class/Device/HID.h

diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h
index 61e5eed28..e4a919ded 100644
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -31,6 +31,10 @@
 /** \ingroup Group_USBClassHID
  *  @defgroup Group_USBClassHIDDevice HID Class Device Mode Driver
  *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - LUFA/Drivers/USB/Class/Device/HID.c
+ *
  *  \section Module Description
  *  Device Mode USB Class driver framework interface, for the HID USB Class driver.
  *
@@ -89,7 +93,7 @@
 			 *  \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration
 			 *  containing the given HID interface is selected.
 			 *
-			 *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
+			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
 			 *
 			 *  \return Boolean true if the endpoints were sucessfully configured, false otherwise
 			 */
@@ -98,14 +102,14 @@
 			/** Processes incomming control requests from the host, that are directed to the given HID class interface. This should be
 			 *  linked to the library \ref EVENT_USB_UnhandledControlPacket() event.
 			 *
-			 *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
+			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
 			 */		
 			void HID_Device_ProcessControlPacket(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);
 
 			/** General management task for a given HID class interface, required for the correct operation of the interface. This should
 			 *  be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
 			 *
-			 *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
+			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
 			 */
 			void HID_Device_USBTask(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo);
 			
@@ -113,11 +117,11 @@
 			 *  HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the
 			 *  user is responsible for the creation of the next HID input report to be sent to the host.
 			 *
-			 *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
-			 *  \param ReportID  If preset to a non-zero value, this is the report ID being requested by the host. If zero, this should
-			 *                   be set to the report ID of the generated HID input report. If multiple reports are not sent via the
-			 *                   given HID interface, this parameter should be ignored.
-			 *  \param ReportData  Pointer to a buffer where the generated HID report should be stored.
+			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
+			 *  \param[in,out] ReportID  If preset to a non-zero value, this is the report ID being requested by the host. If zero, this should
+			 *                 be set to the report ID of the generated HID input report. If multiple reports are not sent via the
+			 *                 given HID interface, this parameter should be ignored.
+			 *  \param[out] ReportData  Pointer to a buffer where the generated HID report should be stored.
 			 *
 			 *  \return  Number of bytes in the generated input report, or zero if no report is to be sent
 			 */
@@ -127,14 +131,14 @@
 			 *  either HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback
 			 *  the user is responsible for the processing of the received HID output report from the host.
 			 *
-			 *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
-			 *  \param ReportID  Report ID of the received output report. If multiple reports are not received via the given HID
+			 *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.
+			 *  \param[in] ReportID  Report ID of the received output report. If multiple reports are not received via the given HID
 			 *                   interface, this parameter should be ignored.
-			 *  \param ReportData  Pointer to a buffer where the received HID report is stored.
-			 *  \param ReportSize  Size in bytes of the received report from the host.
+			 *  \param[in] ReportData  Pointer to a buffer where the received HID report is stored.
+			 *  \param[in] ReportSize  Size in bytes of the received report from the host.
 			 */
-			void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData,
-													  uint16_t ReportSize);
+			void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, const uint8_t ReportID,
+			                                          const void* ReportData, const uint16_t ReportSize);
 
 	/* Disable C linkage for C++ Compilers: */
 		#if defined(__cplusplus)