Fix spacing of the function parameter descriptions in the Doxygen documentation.

[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 1291bd2..88c514b 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -155,9 +155,9 @@
                         *  \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
                         *        to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.
                         *
                         *  \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call
                         *        to either the \ref HID_Host_SetBootProtocol() or \ref HID_Host_SetReportProtocol() function.
                         *

-                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state
-                        *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
-                        *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
+                        *  \param[in,out] HIDInterfaceInfo        Pointer to a structure containing a HID Class host configuration and state
+                        *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor
+                        *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor

                         *
                         *  \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum
                         */


@@ -175,7 +175,7 @@
                         *        can generate.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state
                         *        can generate.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state

-                        *  \param[in] Buffer  Buffer to store the received report into
+                        *  \param[in]     Buffer            Buffer to store the received report into

                         *
                         *  \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */
                         *
                         *  \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum
                         */


@@ -192,8 +192,8 @@
                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state
                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state

-                        *  \param[in] ReportID  Report ID of the received report if ControlRequest is false, set by the to the Report ID to fetch
-                        *  \param[in] Buffer  Buffer to store the received report into
+                        *  \param[in]     ReportID          Report ID of the received report if ControlRequest is false, set by the to the Report ID to fetch
+                        *  \param[in]     Buffer            Buffer to store the received report into

                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
                         */
                         *
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
                         */


@@ -201,8 +201,8 @@
                                                           void* Buffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
                        #endif
                        
                                                           void* Buffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
                        #endif
                        

-                       /** Sends an OUT report to the currently attached HID device, using the device's OUT pipe if available or the device's
-                        *  Control pipe if not.
+                       /** Sends an OUT or FEATURE report to the currently attached HID device, using the device's OUT pipe if available,
+                        *  or the device's Control pipe if not.

                         *
                         *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
                         *        call will fail.
                         *
                         *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
                         *        call will fail.


@@ -212,9 +212,10 @@
                         *        from the parameter list of this function.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state
                         *        from the parameter list of this function.
                         *
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state

-                        *  \param[in] ReportID  Report ID of the report to send to the device, or 0 if the device does not use report IDs
-                        *  \param[in] Buffer  Buffer containing the report to send to the attached device
-                        *  \param[in] ReportSize  Report size in bytes to send to the attached device
+                        *  \param[in]     ReportID          Report ID of the report to send to the device, or 0 if the device does not use report IDs
+                        *  \param[in]     ReportType        Type of report to issue to the device, either \ref REPORT_ITEM_TYPE_Out or \ref REPORT_ITEM_TYPE_Feature
+                        *  \param[in]     Buffer            Buffer containing the report to send to the attached device
+                        *  \param[in]     ReportSize        Report size in bytes to send to the attached device

                         *
                         *  \return An error code from the \ref USB_Host_SendControlErrorCodes_t enum if the DeviceUsesOUTPipe flag is set in
                         *          the interface's state structure, a value from the \ref Pipe_Stream_RW_ErrorCodes_t enum otherwise
                         *
                         *  \return An error code from the \ref USB_Host_SendControlErrorCodes_t enum if the DeviceUsesOUTPipe flag is set in
                         *          the interface's state structure, a value from the \ref Pipe_Stream_RW_ErrorCodes_t enum otherwise


@@ -223,11 +224,11 @@
                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
                                                        const uint8_t ReportID,
                        #endif
                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
                                                        const uint8_t ReportID,
                        #endif

-                                                       void* Buffer, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)
+                                                       const uint8_t ReportType, void* Buffer, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)

                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
                        #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)

-                                                       ATTR_NON_NULL_PTR_ARG(3);
+                                                       ATTR_NON_NULL_PTR_ARG(4);

                        #else
                        #else

-                                                       ATTR_NON_NULL_PTR_ARG(2);
+                                                       ATTR_NON_NULL_PTR_ARG(3);

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


@@ -296,9 +297,9 @@
 
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_HID_CLASS_HOST_C)
 
                /* Function Prototypes: */
                        #if defined(__INCLUDE_FROM_HID_CLASS_HOST_C)

-                               static uint8_t DComp_HID_Host_NextHIDInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
-                               static uint8_t DComp_NextHID(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
-                               static uint8_t DComp_HID_Host_NextHIDInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+                               static uint8_t DCOMP_HID_Host_NextHIDInterface(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+                               static uint8_t DCOMP_HID_NextHID(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);
+                               static uint8_t DCOMP_HID_Host_NextHIDInterfaceEndpoint(void* const CurrentDescriptor) ATTR_NON_NULL_PTR_ARG(1);

                        #endif  
        #endif  
        
                        #endif  
        #endif