Added const modifiers to device mode class drivers.
[pub/lufa.git] / LUFA / Drivers / USB / Class / Host / HIDParser.h
index 4acce24..f878aa1 100644 (file)
                        /** Function to process a given HID report returned from an attached device, and store it into a given\r
                         *  \ref HID_ReportInfo_t structure.\r
                         *\r
-                        *  \param ReportData  Buffer containing the device's HID report table\r
-                        *  \param ReportSize  Size in bytes of the HID report table\r
-                        *  \param ParserData  Pointer to a \ref HID_ReportInfo_t instance for the parser output\r
+                        *  \param[in] ReportData  Buffer containing the device's HID report table\r
+                        *  \param[in] ReportSize  Size in bytes of the HID report table\r
+                        *  \param[out] ParserData  Pointer to a \ref HID_ReportInfo_t instance for the parser output\r
                         *\r
                         *  \return A value in the \ref HID_Parse_ErrorCodes_t enum\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 \ref HID_ReportItem_t structure.\r
                         *\r
-                        *  \param ReportData  Buffer containing an IN or FEATURE report from an attached device\r
-                        *  \param ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array\r
+                        *  \param[in] ReportData  Buffer containing an IN or FEATURE report from an attached device\r
+                        *  \param[in,out] ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array\r
                         *\r
                         *  \returns Boolean true if the item to retrieve was located in the given report, false otherwise\r
                         */\r
                         *\r
                         *  If the device has multiple HID reports, the report ID is set to the report ID of the given item.\r
                         *\r
-                        *  \param ReportData  Buffer holding the current OUT report data\r
-                        *  \param ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array\r
+                        *  \param[out] ReportData  Buffer holding the current OUT report data\r
+                        *  \param[in] ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array\r
                         */\r
                        void USB_SetHIDReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)\r
                                                      ATTR_NON_NULL_PTR_ARG(1, 2);\r