summaryrefslogtreecommitdiff
path: root/libusb/libusb.h
diff options
context:
space:
mode:
authorChris Dickens <christopher.a.dickens@gmail.com>2016-02-24 01:07:20 -0800
committerChris Dickens <christopher.a.dickens@gmail.com>2016-02-24 01:07:20 -0800
commit7ee92df12adb8015451aaecfeccd7dd62cc2314e (patch)
tree69aa53a859edd88b6a79fa21fb2b9f02e35aba4d /libusb/libusb.h
parent8a0c14372f98d56529556f18126a42fda2ab0137 (diff)
downloadlibusb-7ee92df12adb8015451aaecfeccd7dd62cc2314e.tar.gz
Misc: Prefix doxygen references in order to namespace libusb
This change add "libusb_" to every group and page definition (and updates all references accordingly) so that generated man pages are namespaced for libusb, thus avoiding possible conflict with other packages. Closes #131 Signed-off-by: Chris Dickens <christopher.a.dickens@gmail.com>
Diffstat (limited to 'libusb/libusb.h')
-rw-r--r--libusb/libusb.h138
1 files changed, 69 insertions, 69 deletions
diff --git a/libusb/libusb.h b/libusb/libusb.h
index 7fe01db..5b0d522 100644
--- a/libusb/libusb.h
+++ b/libusb/libusb.h
@@ -84,7 +84,7 @@ typedef unsigned __int32 uint32_t;
#endif /* __GNUC__ */
/** \def LIBUSB_CALL
- * \ingroup misc
+ * \ingroup libusb_misc
* libusb's Windows calling convention.
*
* Under Windows, the selection of available compilers and configurations
@@ -122,7 +122,7 @@ typedef unsigned __int32 uint32_t;
#endif
/** \def LIBUSB_API_VERSION
- * \ingroup misc
+ * \ingroup libusb_misc
* libusb's API version.
*
* Since version 1.0.13, to help with feature detection, libusb defines
@@ -151,7 +151,7 @@ extern "C" {
#endif
/**
- * \ingroup misc
+ * \ingroup libusb_misc
* Convert a 16-bit value from host-endian to little-endian format. On
* little endian systems, this function does nothing. On big endian systems,
* the bytes are swapped.
@@ -170,7 +170,7 @@ static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
}
/** \def libusb_le16_to_cpu
- * \ingroup misc
+ * \ingroup libusb_misc
* Convert a 16-bit value from little-endian to host-endian format. On
* little endian systems, this function does nothing. On big endian systems,
* the bytes are swapped.
@@ -181,7 +181,7 @@ static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
/* standard USB stuff */
-/** \ingroup desc
+/** \ingroup libusb_desc
* Device and/or Interface Class codes */
enum libusb_class_code {
/** In the context of a \ref libusb_device_descriptor "device descriptor",
@@ -243,7 +243,7 @@ enum libusb_class_code {
LIBUSB_CLASS_VENDOR_SPEC = 0xff
};
-/** \ingroup desc
+/** \ingroup libusb_desc
* Descriptor types as defined by the USB specification. */
enum libusb_descriptor_type {
/** Device descriptor. See libusb_device_descriptor. */
@@ -311,7 +311,7 @@ enum libusb_descriptor_type {
#define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */
#define LIBUSB_ENDPOINT_DIR_MASK 0x80
-/** \ingroup desc
+/** \ingroup libusb_desc
* Endpoint direction. Values for bit 7 of the
* \ref libusb_endpoint_descriptor::bEndpointAddress "endpoint address" scheme.
*/
@@ -325,7 +325,7 @@ enum libusb_endpoint_direction {
#define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */
-/** \ingroup desc
+/** \ingroup libusb_desc
* Endpoint transfer type. Values for bits 0:1 of the
* \ref libusb_endpoint_descriptor::bmAttributes "endpoint attributes" field.
*/
@@ -346,7 +346,7 @@ enum libusb_transfer_type {
LIBUSB_TRANSFER_TYPE_BULK_STREAM = 4,
};
-/** \ingroup misc
+/** \ingroup libusb_misc
* Standard requests, as defined in table 9-5 of the USB 3.0 specifications */
enum libusb_standard_request {
/** Request status of the specific recipient */
@@ -394,7 +394,7 @@ enum libusb_standard_request {
LIBUSB_SET_ISOCH_DELAY = 0x31,
};
-/** \ingroup misc
+/** \ingroup libusb_misc
* Request type bits of the
* \ref libusb_control_setup::bmRequestType "bmRequestType" field in control
* transfers. */
@@ -412,7 +412,7 @@ enum libusb_request_type {
LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5)
};
-/** \ingroup misc
+/** \ingroup libusb_misc
* Recipient bits of the
* \ref libusb_control_setup::bmRequestType "bmRequestType" field in control
* transfers. Values 4 through 31 are reserved. */
@@ -432,7 +432,7 @@ enum libusb_request_recipient {
#define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C
-/** \ingroup desc
+/** \ingroup libusb_desc
* Synchronization type for isochronous endpoints. Values for bits 2:3 of the
* \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in
* libusb_endpoint_descriptor.
@@ -453,7 +453,7 @@ enum libusb_iso_sync_type {
#define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
-/** \ingroup desc
+/** \ingroup libusb_desc
* Usage type for isochronous endpoints. Values for bits 4:5 of the
* \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in
* libusb_endpoint_descriptor.
@@ -469,7 +469,7 @@ enum libusb_iso_usage_type {
LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,
};
-/** \ingroup desc
+/** \ingroup libusb_desc
* A structure representing the standard USB device descriptor. This
* descriptor is documented in section 9.6.1 of the USB 3.0 specification.
* All multiple-byte fields are represented in host-endian format.
@@ -523,7 +523,7 @@ struct libusb_device_descriptor {
uint8_t bNumConfigurations;
};
-/** \ingroup desc
+/** \ingroup libusb_desc
* A structure representing the standard USB endpoint descriptor. This
* descriptor is documented in section 9.6.6 of the USB 3.0 specification.
* All multiple-byte fields are represented in host-endian format.
@@ -573,7 +573,7 @@ struct libusb_endpoint_descriptor {
int extra_length;
};
-/** \ingroup desc
+/** \ingroup libusb_desc
* A structure representing the standard USB interface descriptor. This
* descriptor is documented in section 9.6.5 of the USB 3.0 specification.
* All multiple-byte fields are represented in host-endian format.
@@ -623,7 +623,7 @@ struct libusb_interface_descriptor {
int extra_length;
};
-/** \ingroup desc
+/** \ingroup libusb_desc
* A collection of alternate settings for a particular USB interface.
*/
struct libusb_interface {
@@ -635,7 +635,7 @@ struct libusb_interface {
int num_altsetting;
};
-/** \ingroup desc
+/** \ingroup libusb_desc
* A structure representing the standard USB configuration descriptor. This
* descriptor is documented in section 9.6.3 of the USB 3.0 specification.
* All multiple-byte fields are represented in host-endian format.
@@ -682,7 +682,7 @@ struct libusb_config_descriptor {
int extra_length;
};
-/** \ingroup desc
+/** \ingroup libusb_desc
* A structure representing the superspeed endpoint companion
* descriptor. This descriptor is documented in section 9.6.7 of
* the USB 3.0 specification. All multiple-byte fields are represented in
@@ -714,7 +714,7 @@ struct libusb_ss_endpoint_companion_descriptor {
uint16_t wBytesPerInterval;
};
-/** \ingroup desc
+/** \ingroup libusb_desc
* A generic representation of a BOS Device Capability descriptor. It is
* advised to check bDevCapabilityType and call the matching
* libusb_get_*_descriptor function to get a structure fully matching the type.
@@ -738,7 +738,7 @@ struct libusb_bos_dev_capability_descriptor {
;
};
-/** \ingroup desc
+/** \ingroup libusb_desc
* A structure representing the Binary Device Object Store (BOS) descriptor.
* This descriptor is documented in section 9.6.2 of the USB 3.0 specification.
* All multiple-byte fields are represented in host-endian format.
@@ -769,7 +769,7 @@ struct libusb_bos_descriptor {
;
};
-/** \ingroup desc
+/** \ingroup libusb_desc
* A structure representing the USB 2.0 Extension descriptor
* This descriptor is documented in section 9.6.2.1 of the USB 3.0 specification.
* All multiple-byte fields are represented in host-endian format.
@@ -795,7 +795,7 @@ struct libusb_usb_2_0_extension_descriptor {
uint32_t bmAttributes;
};
-/** \ingroup desc
+/** \ingroup libusb_desc
* A structure representing the SuperSpeed USB Device Capability descriptor
* This descriptor is documented in section 9.6.2.2 of the USB 3.0 specification.
* All multiple-byte fields are represented in host-endian format.
@@ -837,7 +837,7 @@ struct libusb_ss_usb_device_capability_descriptor {
uint16_t bU2DevExitLat;
};
-/** \ingroup desc
+/** \ingroup libusb_desc
* A structure representing the Container ID descriptor.
* This descriptor is documented in section 9.6.2.3 of the USB 3.0 specification.
* All multiple-byte fields, except UUIDs, are represented in host-endian format.
@@ -863,7 +863,7 @@ struct libusb_container_id_descriptor {
uint8_t ContainerID[16];
};
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Setup packet for control transfers. */
struct libusb_control_setup {
/** Request type. Bits 0:4 determine recipient, see
@@ -899,7 +899,7 @@ struct libusb_context;
struct libusb_device;
struct libusb_device_handle;
-/** \ingroup lib
+/** \ingroup libusb_lib
* Structure providing the version of the libusb runtime
*/
struct libusb_version {
@@ -922,7 +922,7 @@ struct libusb_version {
const char* describe;
};
-/** \ingroup lib
+/** \ingroup libusb_lib
* Structure representing a libusb session. The concept of individual libusb
* sessions allows for your program to use two libraries (or dynamically
* load two modules) which both independently use libusb. This will prevent
@@ -937,11 +937,11 @@ struct libusb_version {
* every function call where a context is required. The default context
* will be used.
*
- * For more information, see \ref contexts.
+ * For more information, see \ref libusb_contexts.
*/
typedef struct libusb_context libusb_context;
-/** \ingroup dev
+/** \ingroup libusb_dev
* Structure representing a USB device detected on the system. This is an
* opaque type for which you are only ever provided with a pointer, usually
* originating from libusb_get_device_list().
@@ -959,7 +959,7 @@ typedef struct libusb_context libusb_context;
typedef struct libusb_device libusb_device;
-/** \ingroup dev
+/** \ingroup libusb_dev
* Structure representing a handle on a USB device. This is an opaque type for
* which you are only ever provided with a pointer, usually originating from
* libusb_open().
@@ -969,7 +969,7 @@ typedef struct libusb_device libusb_device;
*/
typedef struct libusb_device_handle libusb_device_handle;
-/** \ingroup dev
+/** \ingroup libusb_dev
* Speed codes. Indicates the speed at which the device is operating.
*/
enum libusb_speed {
@@ -989,7 +989,7 @@ enum libusb_speed {
LIBUSB_SPEED_SUPER = 4,
};
-/** \ingroup dev
+/** \ingroup libusb_dev
* Supported speeds (wSpeedSupported) bitfield. Indicates what
* speeds the device supports.
*/
@@ -1007,7 +1007,7 @@ enum libusb_supported_speed {
LIBUSB_SUPER_SPEED_OPERATION = 8,
};
-/** \ingroup dev
+/** \ingroup libusb_dev
* Masks for the bits of the
* \ref libusb_usb_2_0_extension_descriptor::bmAttributes "bmAttributes" field
* of the USB 2.0 Extension descriptor.
@@ -1017,7 +1017,7 @@ enum libusb_usb_2_0_extension_attributes {
LIBUSB_BM_LPM_SUPPORT = 2,
};
-/** \ingroup dev
+/** \ingroup libusb_dev
* Masks for the bits of the
* \ref libusb_ss_usb_device_capability_descriptor::bmAttributes "bmAttributes" field
* field of the SuperSpeed USB Device Capability descriptor.
@@ -1027,7 +1027,7 @@ enum libusb_ss_usb_device_capability_attributes {
LIBUSB_BM_LTM_SUPPORT = 2,
};
-/** \ingroup dev
+/** \ingroup libusb_dev
* USB capability types
*/
enum libusb_bos_type {
@@ -1044,7 +1044,7 @@ enum libusb_bos_type {
LIBUSB_BT_CONTAINER_ID = 4,
};
-/** \ingroup misc
+/** \ingroup libusb_misc
* Error codes. Most libusb functions return 0 on success or one of these
* codes on failure.
* You can call libusb_error_name() to retrieve a string representation of an
@@ -1101,7 +1101,7 @@ enum libusb_error {
/* Total number of error codes in enum libusb_error */
#define LIBUSB_ERROR_COUNT 14
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Transfer status codes */
enum libusb_transfer_status {
/** Transfer completed without error. Note that this does not indicate
@@ -1131,7 +1131,7 @@ enum libusb_transfer_status {
when adding new status codes here. */
};
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* libusb_transfer.flags values */
enum libusb_transfer_flags {
/** Report short frames as errors */
@@ -1172,7 +1172,7 @@ enum libusb_transfer_flags {
LIBUSB_TRANSFER_ADD_ZERO_PACKET = 1 << 3,
};
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Isochronous packet descriptor. */
struct libusb_iso_packet_descriptor {
/** Length of data to request in this packet */
@@ -1187,18 +1187,18 @@ struct libusb_iso_packet_descriptor {
struct libusb_transfer;
-/** \ingroup asyncio
+/** \ingroup libusb_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.
+ * completed or failed. See \ref libusb_asyncio for more information.
* \param transfer The libusb_transfer struct the callback function is being
* notified about.
*/
typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* The generic USB transfer structure. The user populates this structure and
* then submits it in order to request a transfer. After the transfer has
* completed, the library populates the transfer with the results and passes
@@ -1262,7 +1262,7 @@ struct libusb_transfer {
;
};
-/** \ingroup misc
+/** \ingroup libusb_misc
* Capabilities supported by an instance of libusb on the current running
* platform. Test if the loaded library supports a given capability by calling
* \ref libusb_has_capability().
@@ -1282,7 +1282,7 @@ enum libusb_capability {
LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER = 0x0101
};
-/** \ingroup lib
+/** \ingroup libusb_lib
* Log message levels.
* - LIBUSB_LOG_LEVEL_NONE (0) : no messages ever printed by the library (default)
* - LIBUSB_LOG_LEVEL_ERROR (1) : error messages are printed to stderr
@@ -1403,7 +1403,7 @@ int LIBUSB_CALL libusb_set_auto_detach_kernel_driver(
/* async I/O */
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Get the data section of a control transfer. This convenience function is here
* to remind you that the data does not start until 8 bytes into the actual
* buffer, as the setup packet comes first.
@@ -1421,7 +1421,7 @@ static inline unsigned char *libusb_control_transfer_get_data(
return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
}
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Get the control setup packet of a control transfer. This convenience
* function is here to remind you that the control setup occupies the first
* 8 bytes of the transfer data buffer.
@@ -1439,7 +1439,7 @@ static inline struct libusb_control_setup *libusb_control_transfer_get_setup(
return (struct libusb_control_setup *)(void *) transfer->buffer;
}
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Helper function to populate the setup packet (first 8 bytes of the data
* buffer) for a control transfer. The wIndex, wValue and wLength values should
* be given in host-endian byte order.
@@ -1483,7 +1483,7 @@ void LIBUSB_CALL libusb_transfer_set_stream_id(
uint32_t LIBUSB_CALL libusb_transfer_get_stream_id(
struct libusb_transfer *transfer);
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Helper function to populate the required \ref libusb_transfer fields
* for a control transfer.
*
@@ -1529,7 +1529,7 @@ static inline void libusb_fill_control_transfer(
transfer->callback = callback;
}
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Helper function to populate the required \ref libusb_transfer fields
* for a bulk transfer.
*
@@ -1557,7 +1557,7 @@ static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
transfer->callback = callback;
}
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Helper function to populate the required \ref libusb_transfer fields
* for a bulk transfer using bulk streams.
*
@@ -1585,7 +1585,7 @@ static inline void libusb_fill_bulk_stream_transfer(
libusb_transfer_set_stream_id(transfer, stream_id);
}
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Helper function to populate the required \ref libusb_transfer fields
* for an interrupt transfer.
*
@@ -1613,7 +1613,7 @@ static inline void libusb_fill_interrupt_transfer(
transfer->callback = callback;
}
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Helper function to populate the required \ref libusb_transfer fields
* for an isochronous transfer.
*
@@ -1643,7 +1643,7 @@ static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
transfer->callback = callback;
}
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Convenience function to set the length of all packets in an isochronous
* transfer, based on the num_iso_packets field in the transfer structure.
*
@@ -1659,7 +1659,7 @@ static inline void libusb_set_iso_packet_lengths(
transfer->iso_packet_desc[i].length = length;
}
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Convenience function to locate the position of an isochronous packet
* within the buffer of an isochronous transfer.
*
@@ -1698,7 +1698,7 @@ static inline unsigned char *libusb_get_iso_packet_buffer(
return transfer->buffer + offset;
}
-/** \ingroup asyncio
+/** \ingroup libusb_asyncio
* Convenience function to locate the position of an isochronous packet
* within the buffer of an isochronous transfer, for transfers where each
* packet is of identical size.
@@ -1749,7 +1749,7 @@ int LIBUSB_CALL libusb_interrupt_transfer(libusb_device_handle *dev_handle,
unsigned char endpoint, unsigned char *data, int length,
int *actual_length, unsigned int timeout);
-/** \ingroup desc
+/** \ingroup libusb_desc
* Retrieve a descriptor from the default control pipe.
* This is a convenience function which formulates the appropriate control
* message to retrieve the descriptor.
@@ -1769,7 +1769,7 @@ static inline int libusb_get_descriptor(libusb_device_handle *dev_handle,
0, data, (uint16_t) length, 1000);
}
-/** \ingroup desc
+/** \ingroup libusb_desc
* Retrieve a descriptor from a device.
* This is a convenience function which formulates the appropriate control
* message to retrieve the descriptor. The string returned is Unicode, as
@@ -1818,7 +1818,7 @@ int LIBUSB_CALL libusb_pollfds_handle_timeouts(libusb_context *ctx);
int LIBUSB_CALL libusb_get_next_timeout(libusb_context *ctx,
struct timeval *tv);
-/** \ingroup poll
+/** \ingroup libusb_poll
* File descriptor for polling
*/
struct libusb_pollfd {
@@ -1832,7 +1832,7 @@ struct libusb_pollfd {
short events;
};
-/** \ingroup poll
+/** \ingroup libusb_poll
* Callback function, invoked when a new file descriptor should be added
* to the set of file descriptors monitored for events.
* \param fd the new file descriptor
@@ -1845,7 +1845,7 @@ struct libusb_pollfd {
typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events,
void *user_data);
-/** \ingroup poll
+/** \ingroup libusb_poll
* Callback function, invoked when a file descriptor should be removed from
* the set of file descriptors being monitored for events. After returning
* from this callback, do not use that file descriptor again.
@@ -1863,7 +1863,7 @@ void LIBUSB_CALL libusb_set_pollfd_notifiers(libusb_context *ctx,
libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
void *user_data);
-/** \ingroup hotplug
+/** \ingroup libusb_hotplug
* Callback handle.
*
* Callbacks handles are generated by libusb_hotplug_register_callback()
@@ -1873,11 +1873,11 @@ void LIBUSB_CALL libusb_set_pollfd_notifiers(libusb_context *ctx,
*
* Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
*
- * For more information, see \ref hotplug.
+ * For more information, see \ref libusb_hotplug.
*/
typedef int libusb_hotplug_callback_handle;
-/** \ingroup hotplug
+/** \ingroup libusb_hotplug
*
* Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
*
@@ -1890,7 +1890,7 @@ typedef enum {
LIBUSB_HOTPLUG_ENUMERATE = 1<<0,
} libusb_hotplug_flag;
-/** \ingroup hotplug
+/** \ingroup libusb_hotplug
*
* Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
*
@@ -1905,11 +1905,11 @@ typedef enum {
LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT = 0x02,
} libusb_hotplug_event;
-/** \ingroup hotplug
+/** \ingroup libusb_hotplug
* Wildcard matching for hotplug events */
#define LIBUSB_HOTPLUG_MATCH_ANY -1
-/** \ingroup hotplug
+/** \ingroup libusb_hotplug
* Hotplug callback function type. When requesting hotplug event notifications,
* you pass a pointer to a callback function of this type.
*
@@ -1917,7 +1917,7 @@ typedef enum {
* recommended the callback do minimal processing before returning.
*
* libusb will call this function later, when a matching event had happened on
- * a matching device. See \ref hotplug for more information.
+ * a matching device. See \ref libusb_hotplug for more information.
*
* It is safe to call either libusb_hotplug_register_callback() or
* libusb_hotplug_deregister_callback() from within a callback function.
@@ -1936,7 +1936,7 @@ typedef int (LIBUSB_CALL *libusb_hotplug_callback_fn)(libusb_context *ctx,
libusb_hotplug_event event,
void *user_data);
-/** \ingroup hotplug
+/** \ingroup libusb_hotplug
* Register a hotplug callback function
*
* Register a callback with the libusb_context. The callback will fire
@@ -1979,7 +1979,7 @@ int LIBUSB_CALL libusb_hotplug_register_callback(libusb_context *ctx,
void *user_data,
libusb_hotplug_callback_handle *callback_handle);
-/** \ingroup hotplug
+/** \ingroup libusb_hotplug
* Deregisters a hotplug callback.
*
* Deregister a callback from a libusb_context. This function is safe to call from within