ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix doxygen documentation - doxygen was getting confused on the variable-length ATTR_NON_NULL_PTR_ARG() macro used on function prototypes and was generating many return types for several functions in the documentation (thanks to David Lyons).

Browse source
This commit is contained in:
Dean Camera 2009-11-17 11:28:07 +00:00
parent 9b20114555
commit d753512cca
21 changed files with 66 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

13
LUFA/Drivers/USB/Class/Host/HID.h
View file

@ -154,7 +154,7 @@
* \return A value from the \ref HIDHost_EnumerationFailure_ErrorCodes_t enum
*/
uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, uint16_t ConfigDescriptorSize,
void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);
void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
/** Receives a HID IN report from the attached HID device, when a report has been received on the HID IN Data pipe.
@ -167,7 +167,8 @@
*
* \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum
*/
uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 2);
uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer)
ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
/** Receives a HID IN report from the attached device, by the report ID.
@ -181,7 +182,7 @@
* \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
*/
uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID,
void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 3);
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
@ -202,11 +203,11 @@
#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
const uint8_t ReportID,
#endif
void* Buffer, const uint16_t ReportSize)
void* Buffer, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1)
#if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)
ATTR_NON_NULL_PTR_ARG(1, 3);
ATTR_NON_NULL_PTR_ARG(3);
#else
ATTR_NON_NULL_PTR_ARG(1, 2);
ATTR_NON_NULL_PTR_ARG(2);
#endif
/** Determines if a HID IN report has been received from the attached device on the data IN pipe.