diff options
| author | Chris Dickens <christopher.a.dickens@gmail.com> | 2020-08-28 15:42:41 -0700 |
|---|---|---|
| committer | Chris Dickens <christopher.a.dickens@gmail.com> | 2020-09-13 00:09:32 -0700 |
| commit | a6bfd45deab1e9550a7e7f8bf618b484da7e2816 (patch) | |
| tree | 512a9d287ec4d6f656280bdc163e6bb16d7f2ac5 /libusb/libusbi.h | |
| parent | ccba488d11e373078aba7b086e3824417b31f67e (diff) | |
| download | libusb-a6bfd45deab1e9550a7e7f8bf618b484da7e2816.tar.gz | |
Doxygen: Fix warnings about undocumented compounds
Commit fa3f91e7c4 ("descriptor: Miscellaneous improvements to the
overall source") introduced some union types, however since descriptor.c
is parsed by Doxygen it will complain with the following warnings:
libusb/descriptor.c:49: warning: Compound string_desc_buf is not documented.
libusb/descriptor.c:55: warning: Compound bos_desc_buf is not documented.
libusb/descriptor.c:43: warning: Compound config_desc_buf is not documented.
Fix this by moving the union definitions into libusbi.h.
Signed-off-by: Chris Dickens <christopher.a.dickens@gmail.com>
Diffstat (limited to 'libusb/libusbi.h')
| -rw-r--r-- | libusb/libusbi.h | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/libusb/libusbi.h b/libusb/libusbi.h index 1208274..c4e705f 100644 --- a/libusb/libusbi.h +++ b/libusb/libusbi.h @@ -630,7 +630,7 @@ struct usbi_interface_descriptor { struct usbi_string_descriptor { uint8_t bLength; uint8_t bDescriptorType; - uint16_t wData[]; + uint16_t wData[ZERO_SIZED_ARRAY]; } LIBUSB_PACKED; struct usbi_bos_descriptor { @@ -644,6 +644,24 @@ struct usbi_bos_descriptor { #pragma pack(pop) #endif +union usbi_config_desc_buf { + struct usbi_configuration_descriptor desc; + uint8_t buf[LIBUSB_DT_CONFIG_SIZE]; + uint16_t align; /* Force 2-byte alignment */ +}; + +union usbi_string_desc_buf { + struct usbi_string_descriptor desc; + uint8_t buf[255]; /* Some devices choke on size > 255 */ + uint16_t align; /* Force 2-byte alignment */ +}; + +union usbi_bos_desc_buf { + struct usbi_bos_descriptor desc; + uint8_t buf[LIBUSB_DT_BOS_SIZE]; + uint16_t align; /* Force 2-byte alignment */ +}; + /* shared data and functions */ int usbi_io_init(struct libusb_context *ctx); |