From dba5597edfb6e6eb47450f9723ae35b307a20f92 Mon Sep 17 00:00:00 2001 From: XieWenxiang Date: Fri, 19 Mar 2021 19:08:00 +0800 Subject: [PATCH] component/bt: Modify some ambiguous descriptions(release v4.3) --- components/bt/controller/esp32c3/Kconfig.in | 3 ++- components/bt/host/bluedroid/api/include/api/esp_gattc_api.h | 2 +- components/bt/include/esp32/include/esp_bt.h | 1 + 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/components/bt/controller/esp32c3/Kconfig.in b/components/bt/controller/esp32c3/Kconfig.in index cc8d516807..cdc1056795 100644 --- a/components/bt/controller/esp32c3/Kconfig.in +++ b/components/bt/controller/esp32c3/Kconfig.in @@ -7,7 +7,8 @@ config BT_CTRL_BLE_MAX_ACT default 10 range 1 10 help - BLE maximum instances of bluetooth controller. + BLE maximum activities of bluetooth controller，both of connections, + scan , sync and adv(periodic adv, multi-adv). config BT_CTRL_BLE_MAX_ACT_EFF int 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 d0a2332b6b..70a9b1536a 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 @@ -313,7 +313,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/esp32/include/esp_bt.h b/components/bt/include/esp32/include/esp_bt.h index 2ef326b04a..c577fd65a7 100644 --- a/components/bt/include/esp32/include/esp_bt.h +++ b/components/bt/include/esp32/include/esp_bt.h @@ -488,6 +488,7 @@ esp_err_t esp_bt_sleep_disable(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