diff options
author | Hans Ulrich Niedermann <hun@n-dimensional.de> | 2009-01-26 00:31:48 +0100 |
---|---|---|
committer | Daniel Drake <dsd@gentoo.org> | 2009-02-01 19:40:18 -0300 |
commit | 894539931e4b4bd85708fe98b956049243cd6fb0 (patch) | |
tree | c391df9aaf628b55f7de4ea9a608f01132bab9ab | |
parent | abe34a2656f8f9f21e53603796c536585e6233ef (diff) | |
download | libusb-894539931e4b4bd85708fe98b956049243cd6fb0.tar.gz |
API docs: describe libusb_transfer_cb_fn type
Add some text describing the libusb_transfer_cb_fn function type
with the semantics I have gathered from reading other parts of
the API docs, referring to the proper section for more details.
[dsd: tweaked the description slightly]
-rw-r--r-- | libusb/libusb.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/libusb/libusb.h b/libusb/libusb.h index fab053e..7699138 100644 --- a/libusb/libusb.h +++ b/libusb/libusb.h @@ -690,6 +690,15 @@ struct libusb_iso_packet_descriptor { struct libusb_transfer; +/** \ingroup asyncio + * Asynchronous transfer callback function type. When submitting asynchronous + * transfers, you pass a pointer to a callback function of this type via the + * \ref libusb_transfer::callback "callback" member of the libusb_transfer + * structure. libusb will call this function later, when the transfer has + * completed or failed. See \ref asyncio for more information. + * \param transfer The libusb_transfer struct the callback function is being + * notified about. + */ typedef void (*libusb_transfer_cb_fn)(struct libusb_transfer *transfer); /** \ingroup asyncio |