From 9daeddac0baad0a1e375ffe15a4583e07d1463b0 Mon Sep 17 00:00:00 2001 From: XieWenxiang Date: Fri, 19 Mar 2021 19:17:35 +0800 Subject: [PATCH] component/bt: Modify some ambiguous descriptions(release v4.1) --- components/bt/host/bluedroid/api/include/api/esp_gattc_api.h | 2 +- components/bt/include/esp_bt.h | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/components/bt/host/bluedroid/api/include/api/esp_gattc_api.h b/components/bt/host/bluedroid/api/include/api/esp_gattc_api.h index 407ebcf9b2..e56f81d08b 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_gattc_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_gattc_api.h @@ -312,7 +312,7 @@ esp_err_t esp_ble_gattc_app_unregister(esp_gatt_if_t gattc_if); * @param[in] gattc_if: Gatt client access interface. * @param[in] remote_bda: remote device bluetooth device address. * @param[in] remote_addr_type: remote device bluetooth device the address type. - * @param[in] is_direct: direct connection or background auto connection + * @param[in] is_direct: direct connection or background auto connection(by now, background auto connection is not supported). * * @return * - ESP_OK: success diff --git a/components/bt/include/esp_bt.h b/components/bt/include/esp_bt.h index 3a588e7fd3..db1aabff72 100644 --- a/components/bt/include/esp_bt.h +++ b/components/bt/include/esp_bt.h @@ -471,6 +471,7 @@ esp_err_t esp_bt_sleep_enable(void); * Note that scan duplicate list will be automatically cleared when the maximum amount of device in the filter is reached * the amount of device in the filter can be configured in menuconfig. * + * @note This function name is incorrectly spelled, it will be fixed in release 5.x version. * * @return * - ESP_OK : success