diff options
author | Geoffrey Kruse | 2021-03-07 15:54:07 -0800 |
---|---|---|
committer | Nikias Bassen | 2022-05-05 19:00:09 +0200 |
commit | ef94d2370063b6a409ff338dc87c06c2bb6d22c2 (patch) | |
tree | 71fc5008b04aafac77c07486e2dbff94e94a238e /include/libimobiledevice | |
parent | 881d76c753846d38f7207fc992ea7fd1fd4692ed (diff) | |
download | libimobiledevice-ef94d2370063b6a409ff338dc87c06c2bb6d22c2.tar.gz libimobiledevice-ef94d2370063b6a409ff338dc87c06c2bb6d22c2.tar.bz2 |
idevicebtlogger: Minor cleanup
Diffstat (limited to 'include/libimobiledevice')
-rw-r--r-- | include/libimobiledevice/bt_packet_logger.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/include/libimobiledevice/bt_packet_logger.h b/include/libimobiledevice/bt_packet_logger.h index 8916219..230040a 100644 --- a/include/libimobiledevice/bt_packet_logger.h +++ b/include/libimobiledevice/bt_packet_logger.h @@ -53,7 +53,7 @@ typedef struct { typedef struct bt_packet_logger_client_private bt_packet_logger_client_private; typedef bt_packet_logger_client_private *bt_packet_logger_client_t; /**< The client handle. */ -/** Receives each character received from the device. */ +/** Receives each hci packet received from the device. */ typedef void (*bt_packet_logger_receive_cb_t)(uint8_t * data, uint16_t len, void *user_data); /* Interface */ @@ -100,32 +100,32 @@ bt_packet_logger_error_t bt_packet_logger_client_free(bt_packet_logger_client_t /** - * Starts capturing the syslog of the device using a callback. + * Starts capturing the hci interface from the device using a callback. * - * Use bt_packet_logger_stop_capture() to stop receiving the syslog. + * Use bt_packet_logger_stop_capture() to stop receiving hci data. * * @param client The bt_packet_logger client to use - * @param callback Callback to receive each character from the syslog. + * @param callback Callback to receive each packet from the hci interface. * @param user_data Custom pointer passed to the callback function. * * @return BT_PACKET_LOGGER_E_SUCCESS on success, * BT_PACKET_LOGGER_E_INVALID_ARG when one or more parameters are * invalid or BT_PACKET_LOGGER_E_UNKNOWN_ERROR when an unspecified - * error occurs or a syslog capture has already been started. + * error occurs or an hci capture has already been started. */ bt_packet_logger_error_t bt_packet_logger_start_capture(bt_packet_logger_client_t client, bt_packet_logger_receive_cb_t callback, void* user_data); /** - * Stops capturing the syslog of the device. + * Stops capturing the hci interface from the device. * - * Use bt_packet_logger_start_capture() to start receiving the syslog. + * Use bt_packet_logger_start_capture() to start receiving the hci data. * * @param client The bt_packet_logger client to use * * @return BT_PACKET_LOGGER_E_SUCCESS on success, * BT_PACKET_LOGGER_E_INVALID_ARG when one or more parameters are * invalid or BT_PACKET_LOGGER_E_UNKNOWN_ERROR when an unspecified - * error occurs or a syslog capture has already been started. + * error occurs or an hci capture has already been started. */ bt_packet_logger_error_t bt_packet_logger_stop_capture(bt_packet_logger_client_t client); |