diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2010-05-29 08:08:26 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2010-05-29 08:08:26 +0000 |
commit | 328ed71ce728de4a6633d981441ac9837c9cd62a (patch) | |
tree | 0dede6a3b20f65700d3570adb68cf377c9977f23 /LUFA/Drivers/USB/Class/Device | |
parent | c1daecf18b25566da50beb3afdcbc3e5d49d3b48 (diff) | |
download | lufa-328ed71ce728de4a6633d981441ac9837c9cd62a.tar.gz lufa-328ed71ce728de4a6633d981441ac9837c9cd62a.tar.bz2 lufa-328ed71ce728de4a6633d981441ac9837c9cd62a.zip |
Fix spacing of the function parameter descriptions in the Doxygen documentation.
Diffstat (limited to 'LUFA/Drivers/USB/Class/Device')
-rw-r--r-- | LUFA/Drivers/USB/Class/Device/CDC.h | 12 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Device/HID.h | 22 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Device/MIDI.h | 4 |
3 files changed, 19 insertions, 19 deletions
diff --git a/LUFA/Drivers/USB/Class/Device/CDC.h b/LUFA/Drivers/USB/Class/Device/CDC.h index f0351f5d9..8a0cb6abd 100644 --- a/LUFA/Drivers/USB/Class/Device/CDC.h +++ b/LUFA/Drivers/USB/Class/Device/CDC.h @@ -206,9 +206,9 @@ * \note This function must only be called when the Device state machine is in the DEVICE_STATE_Configured state or * the call will fail. * - * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state - * \param[in] Data Pointer to the string to send to the host - * \param[in] Length Size in bytes of the string to send to the host + * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state + * \param[in] Data Pointer to the string to send to the host + * \param[in] Length Size in bytes of the string to send to the host * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum */ @@ -224,7 +224,7 @@ * the call will fail. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state - * \param[in] Data Byte of data to send to the host + * \param[in] Data Byte of data to send to the host * * \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum */ @@ -290,7 +290,7 @@ * to the given CDC interface. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state - * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed + * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed */ void CDC_Device_CreateStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream); @@ -298,7 +298,7 @@ * the transfer. While blocking, the USB and CDC service tasks are called repeatedly to maintain USB communications. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class configuration and state - * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed + * \param[in,out] Stream Pointer to a FILE structure where the created stream should be placed */ void CDC_Device_CreateBlockingStream(USB_ClassInfo_CDC_Device_t* CDCInterfaceInfo, FILE* Stream); diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h index 9e42843d4..4088e870e 100644 --- a/LUFA/Drivers/USB/Class/Device/HID.h +++ b/LUFA/Drivers/USB/Class/Device/HID.h @@ -153,12 +153,12 @@ * user is responsible for the creation of the next HID input report to be sent to the host. * * \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 any). If multiple reports are not sent via the - * given HID interface, this parameter should be ignored. - * \param[in] ReportType Type of HID report to generate, either \ref REPORT_ITEM_TYPE_In or \ref REPORT_ITEM_TYPE_Feature - * \param[out] ReportData Pointer to a buffer where the generated HID report should be stored - * \param[out] ReportSize Number of bytes in the generated input report, or zero if no report is to be sent + * \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 any). If multiple + * reports are not sent via the given HID interface, this parameter should be ignored. + * \param[in] ReportType Type of HID report to generate, either \ref REPORT_ITEM_TYPE_In or \ref REPORT_ITEM_TYPE_Feature + * \param[out] ReportData Pointer to a buffer where the generated HID report should be stored + * \param[out] ReportSize Number of bytes in the generated input report, or zero if no report is to be sent * * \return Boolean true to force the sending of the report even if it is identical to the previous report and still within * the idle period (useful for devices which report relative movement), false otherwise @@ -172,11 +172,11 @@ * the user is responsible for the processing of the received HID output report from the host. * * \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[in] ReportType Type of received HID report, either \ref REPORT_ITEM_TYPE_Out or \ref REPORT_ITEM_TYPE_Feature - * \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. + * \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[in] ReportType Type of received HID report, either \ref REPORT_ITEM_TYPE_Out or \ref REPORT_ITEM_TYPE_Feature + * \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* const HIDInterfaceInfo, const uint8_t ReportID, const uint8_t ReportType, const void* ReportData, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1) diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h index c4b871528..9529f17c2 100644 --- a/LUFA/Drivers/USB/Class/Device/MIDI.h +++ b/LUFA/Drivers/USB/Class/Device/MIDI.h @@ -120,7 +120,7 @@ * the call will fail. * * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state - * \param[in] Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send + * \param[in] Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send * * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum */ @@ -144,7 +144,7 @@ * the call will fail. * * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state - * \param[out] Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed + * \param[out] Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed * * \return Boolean true if a MIDI event packet was received, false otherwise */ |