From 5bf8bb6d3ad3ddd878f4debe672a501420106035 Mon Sep 17 00:00:00 2001 From: liminyang Date: Mon, 29 Jun 2020 11:57:36 +0800 Subject: [PATCH] docs:fix event typo 1.In the description of the ESP_API header file, it should be the event that the application layer needs to handle, not the BTA layer. 2.Fix name typo of BTA_GATTS_CREATE_SRVC_EVT event Closes https://github.com/espressif/esp-idf/issues/5446 --- .../bt/host/bluedroid/api/include/api/esp_gatts_api.h | 8 ++++---- components/bt/host/bluedroid/bta/gatt/bta_gatts_api.c | 2 +- .../bt/host/bluedroid/bta/include/bta/bta_gatt_api.h | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/components/bt/host/bluedroid/api/include/api/esp_gatts_api.h b/components/bt/host/bluedroid/api/include/api/esp_gatts_api.h index 341e71b79..42dfeb26b 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_gatts_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_gatts_api.h @@ -326,7 +326,7 @@ esp_err_t esp_ble_gatts_app_unregister(esp_gatt_if_t gatts_if); /** * @brief Create a service. When service creation is done, a callback - * event BTA_GATTS_CREATE_SRVC_EVT is called to report status + * event ESP_GATTS_CREATE_EVT is called to report status * and service ID to the profile. The service ID obtained in * the callback function needs to be used when adding included * service and characteristics/descriptors into the service. @@ -363,7 +363,7 @@ esp_err_t esp_ble_gatts_create_attr_tab(const esp_gatts_attr_db_t *gatts_attr_db /** * @brief This function is called to add an included service. This function have to be called between * 'esp_ble_gatts_create_service' and 'esp_ble_gatts_add_char'. After included - * service is included, a callback event BTA_GATTS_ADD_INCL_SRVC_EVT + * service is included, a callback event ESP_GATTS_ADD_INCL_SRVC_EVT * is reported the included service ID. * * @param[in] service_handle: service handle to which this included service is to @@ -402,7 +402,7 @@ esp_err_t esp_ble_gatts_add_char(uint16_t service_handle, esp_bt_uuid_t *char_ /** * @brief This function is called to add characteristic descriptor. When - * it's done, a callback event BTA_GATTS_ADD_DESCR_EVT is called + * it's done, a callback event ESP_GATTS_ADD_DESCR_EVT is called * to report the status and an ID number for this descriptor. * * @param[in] service_handle: service handle to which this characteristic descriptor is to @@ -425,7 +425,7 @@ esp_err_t esp_ble_gatts_add_char_descr (uint16_t service_handle, /** * @brief This function is called to delete a service. When this is done, - * a callback event BTA_GATTS_DELETE_EVT is report with the status. + * a callback event ESP_GATTS_DELETE_EVT is report with the status. * * @param[in] service_handle: service_handle to be deleted. * diff --git a/components/bt/host/bluedroid/bta/gatt/bta_gatts_api.c b/components/bt/host/bluedroid/bta/gatt/bta_gatts_api.c index f06a2976e..32f2921ba 100644 --- a/components/bt/host/bluedroid/bta/gatt/bta_gatts_api.c +++ b/components/bt/host/bluedroid/bta/gatt/bta_gatts_api.c @@ -136,7 +136,7 @@ void BTA_GATTS_AppDeregister(tBTA_GATTS_IF server_if) ** Function BTA_GATTS_CreateService ** ** Description Create a service. When service creation is done, a callback -** event BTA_GATTS_CREATE_SRVC_EVT is called to report status +** event BTA_GATTS_CREATE_EVT is called to report status ** and service ID to the profile. The service ID obtained in ** the callback function needs to be used when adding included ** service and characteristics/descriptors into the service. diff --git a/components/bt/host/bluedroid/bta/include/bta/bta_gatt_api.h b/components/bt/host/bluedroid/bta/include/bta/bta_gatt_api.h index a1e22d537..3645c1571 100644 --- a/components/bt/host/bluedroid/bta/include/bta/bta_gatt_api.h +++ b/components/bt/host/bluedroid/bta/include/bta/bta_gatt_api.h @@ -1254,7 +1254,7 @@ extern void BTA_GATTS_AppDeregister(tBTA_GATTS_IF server_if); ** Function BTA_GATTS_CreateService ** ** Description Create a service. When service creation is done, a callback -** event BTA_GATTS_CREATE_SRVC_EVT is called to report status +** event BTA_GATTS_CREATE_EVT is called to report status ** and service ID to the profile. The service ID obtained in ** the callback function needs to be used when adding included ** service and characteristics/descriptors into the service.