diff options
author | Daniel Drake <dsd@gentoo.org> | 2008-05-05 21:34:31 +0100 |
---|---|---|
committer | Daniel Drake <dsd@gentoo.org> | 2008-05-05 21:36:59 +0100 |
commit | 885c2a5de69d6b7d8902bb55d6d83680a5a1a6e5 (patch) | |
tree | aef9f353266cf4414c6d48b250148e4eeafcdc90 /libusb/libusb.h | |
parent | 59c205d542b43d79fe28622dbe8f03a3a3300b6f (diff) | |
download | libusb-885c2a5de69d6b7d8902bb55d6d83680a5a1a6e5.tar.gz |
documentation touchups
Diffstat (limited to 'libusb/libusb.h')
-rw-r--r-- | libusb/libusb.h | 31 |
1 files changed, 24 insertions, 7 deletions
diff --git a/libusb/libusb.h b/libusb/libusb.h index 97b3847..3f04e91 100644 --- a/libusb/libusb.h +++ b/libusb/libusb.h @@ -142,7 +142,8 @@ enum libusb_transfer_type { LIBUSB_TRANSFER_TYPE_INTERRUPT = 3, }; -/** Standard requests, as defined in table 9-3 of the USB2 specifications */ +/** \ingroup misc + * Standard requests, as defined in table 9-3 of the USB2 specifications */ enum libusb_standard_request { /** Request status of the specific recipient */ LIBUSB_REQUEST_GET_STATUS = 0x00, @@ -346,11 +347,19 @@ struct libusb_endpoint_descriptor { /** Interval for polling endpoint for data transfers. */ uint8_t bInterval; + /** For audio devices only: the rate at which synchronization feedback + * is provided. */ uint8_t bRefresh; + + /** For audio devices only: the address if the synch endpoint */ uint8_t bSynchAddress; - const unsigned char *extra; /* Extra descriptors */ - int extralen; + /** Extra descriptors. If libusb encounters unknown endpoint descriptors, + * it will store them here, should you wish to parse them. */ + const unsigned char *extra; + + /** Length of the extra descriptors, in bytes. */ + int extra_length; }; /** \ingroup desc @@ -395,8 +404,12 @@ struct libusb_interface_descriptor { * by the bNumEndpoints field. */ const struct libusb_endpoint_descriptor *endpoint; - const unsigned char *extra; /* Extra descriptors */ - int extralen; + /** Extra descriptors. If libusb encounters unknown interface descriptors, + * it will store them here, should you wish to parse them. */ + const unsigned char *extra; + + /** Length of the extra descriptors, in bytes. */ + int extra_length; }; /** \ingroup desc @@ -449,8 +462,12 @@ struct libusb_config_descriptor { * this array is determined by the bNumInterfaces field. */ const struct libusb_interface *interface; - const unsigned char *extra; /* Extra descriptors */ - int extralen; + /** Extra descriptors. If libusb encounters unknown configuration + * descriptors, it will store them here, should you wish to parse them. */ + const unsigned char *extra; + + /** Length of the extra descriptors, in bytes. */ + int extra_length; }; /** \ingroup asyncio |