Add Doxygen documentation to the completed portions of the PDI programming protocol...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / HID.h

diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h
index 89cb3d8..f6bd81c 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -105,10 +105,10 @@
                                        bool SupportsBootProtocol; /**< Indicates if the current interface instance supports the HID Boot\r
                                                                    *   Protocol when enabled via \ref HID_Host_SetBootProtocol()\r
                                                                    */\r
                                        bool SupportsBootProtocol; /**< Indicates if the current interface instance supports the HID Boot\r
                                                                    *   Protocol when enabled via \ref HID_Host_SetBootProtocol()\r
                                                                    */\r

-                                       bool DeviceUsesOUTPipe; /**< Indicates if the current interface instance uses a seperate OUT data pipe for\r
+                                       bool DeviceUsesOUTPipe; /**< Indicates if the current interface instance uses a separate OUT data pipe for\r

                                                                 *   OUT reports, or if OUT reports are sent via the control pipe instead.\r
                                                                 */\r
                                                                 *   OUT reports, or if OUT reports are sent via the control pipe instead.\r
                                                                 */\r

-                                       bool UsingBootProtocol; /**< Indicates that the interface is currently initialised in Boot Protocol mode */\r
+                                       bool UsingBootProtocol; /**< Indicates that the interface is currently initialized in Boot Protocol mode */\r

                                        uint16_t HIDReportSize; /**< Size in bytes of the HID report descriptor in the device */\r
                                        \r
                                        uint8_t LargestReportSize; /**< Largest report the device will send, in bytes */\r
                                        uint16_t HIDReportSize; /**< Size in bytes of the HID report descriptor in the device */\r
                                        \r
                                        uint8_t LargestReportSize; /**< Largest report the device will send, in bytes */\r


@@ -154,20 +154,24 @@
                         *  \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum\r
                         */\r
                        uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, uint16_t ConfigDescriptorSize,\r
                         *  \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum\r
                         */\r
                        uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, uint16_t ConfigDescriptorSize,\r

-                                                       void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                                                       void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);\r

 \r
 \r
                        /** Receives a HID IN report from the attached HID device, when a report has been received on the HID IN Data pipe.\r
 \r
 \r
                        /** Receives a HID IN report from the attached HID device, when a report has been received on the HID IN Data pipe.\r

+                        *  \r
+                        *  \note The destination buffer should be large enough to accommodate the largest report that the attached device\r
+                        *        can generate.\r

                         *\r
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
                         *  \param[in] Buffer  Buffer to store the received report into\r
                         *\r
                         *  \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
                         */\r
                         *\r
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
                         *  \param[in] Buffer  Buffer to store the received report into\r
                         *\r
                         *  \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
                         */\r

-                       uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 2);\r
+                       uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer)\r
+                                                      ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r

 \r
                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
 \r
                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r

-                       /** Received a HID IN report from the attached device, by the report ID.\r
+                       /** Receives a HID IN report from the attached device, by the report ID.\r

                         *\r
                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\r
                         *\r
                         *\r
                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\r
                         *\r


@@ -178,7 +182,7 @@
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
                         */\r
                        uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID,\r
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
                         */\r
                        uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID,\r

-                                                          void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                                                          void* Buffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);\r

                        #endif\r
                        \r
                        /** Sends an OUT report to the currently attached HID device, using the device's OUT pipe if available or the device's\r
                        #endif\r
                        \r
                        /** Sends an OUT report to the currently attached HID device, using the device's OUT pipe if available or the device's\r


@@ -199,11 +203,11 @@
                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
                                                        const uint8_t ReportID,\r
                        #endif\r
                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
                                                        const uint8_t ReportID,\r
                        #endif\r

-                                                       void* Buffer, const uint16_t ReportSize)\r
+                                                       void* Buffer, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)\r

                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r

-                                                       ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                                                       ATTR_NON_NULL_PTR_ARG(3);\r

                        #else\r
                        #else\r

-                                                       ATTR_NON_NULL_PTR_ARG(1, 2);\r
+                                                       ATTR_NON_NULL_PTR_ARG(2);\r

                        #endif\r
 \r
                        /** Determines if a HID IN report has been received from the attached device on the data IN pipe.\r
                        #endif\r
 \r
                        /** Determines if a HID IN report has been received from the attached device on the data IN pipe.\r